Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IoTSpaces

Package version

Class representing a IoTSpaces.

Hierarchy

  • IoTSpaces

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotSpaceDescription: IoTSpacesDescription, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create or update the metadata of an IoTSpaces instance. The usual pattern to modify a property is to retrieve the IoTSpaces instance metadata and security metadata, and then combine them with the modified values in a new body to update the IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • iotSpaceDescription: IoTSpacesDescription

      The IoTSpaces instance metadata and security metadata.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Delete an IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdate

  • beginUpdate(resourceGroupName: string, resourceName: string, iotSpacePatchDescription: IoTSpacesPatchDescription, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Update the metadata of a IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • iotSpacePatchDescription: IoTSpacesPatchDescription

      The IoTSpaces instance metadata and security metadata.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

checkNameAvailability

  • Check if an IoTSpaces instance name is available.

    Parameters

    • operationInputs: OperationInputs

      Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesCheckNameAvailabilityResponse>

    Promise<Models.IoTSpacesCheckNameAvailabilityResponse>

  • Parameters

    Returns void

  • Parameters

    • operationInputs: OperationInputs

      Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<IoTSpacesNameAvailabilityInfo>

      The callback

    Returns void

createOrUpdate

  • createOrUpdate(resourceGroupName: string, resourceName: string, iotSpaceDescription: IoTSpacesDescription, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesCreateOrUpdateResponse>

  • Create or update the metadata of an IoTSpaces instance. The usual pattern to modify a property is to retrieve the IoTSpaces instance metadata and security metadata, and then combine them with the modified values in a new body to update the IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • iotSpaceDescription: IoTSpacesDescription

      The IoTSpaces instance metadata and security metadata.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesCreateOrUpdateResponse>

    Promise<Models.IoTSpacesCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesDeleteMethodResponse>

  • Delete an IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesDeleteMethodResponse>

    Promise<Models.IoTSpacesDeleteMethodResponse>

get

  • get(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesGetResponse>
  • get(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<IoTSpacesDescription>): void
  • get(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IoTSpacesDescription>): void

  • Get the metadata of a IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesGetResponse>

    Promise<Models.IoTSpacesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • callback: msRest.ServiceCallback<IoTSpacesDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<IoTSpacesDescription>

      The callback

    Returns void

list

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void

  • Get all the IoTSpaces instances in a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesListByResourceGroupResponse>

    Promise<Models.IoTSpacesListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void

  • Get all the IoTSpaces instances in a resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesListByResourceGroupNextResponse>

    Promise<Models.IoTSpacesListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>): void

  • Get all the IoTSpaces instances in a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesListNextResponse>

    Promise<Models.IoTSpacesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<IoTSpacesDescriptionListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, resourceName: string, iotSpacePatchDescription: IoTSpacesPatchDescription, options?: msRest.RequestOptionsBase): Promise<Models.IoTSpacesUpdateResponse>

  • Update the metadata of a IoTSpaces instance.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the IoTSpaces instance.

    • resourceName: string

      The name of the IoTSpaces instance.

    • iotSpacePatchDescription: IoTSpacesPatchDescription

      The IoTSpaces instance metadata and security metadata.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.IoTSpacesUpdateResponse>

    Promise<Models.IoTSpacesUpdateResponse>

Generated using TypeDoc