IoTSpaces class
Class representing a IoTSpaces.
Constructors
| Io |
Create a IoTSpaces. |
Methods
Constructor Details
IoTSpaces(IoTSpacesClientContext)
Create a IoTSpaces.
new IoTSpaces(client: IoTSpacesClientContext)Parameters
- client
- IoTSpacesClientContext
Reference to the service client.
Method Details
beginCreateOrUpdate(string, string, IoTSpacesDescription, RequestOptionsBase)
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.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotSpaceDescription: IoTSpacesDescription, options?: RequestOptionsBase): Promise<LROPoller>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.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, RequestOptionsBase)
Delete an IoTSpaces instance.
function beginDeleteMethod(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- resourceName
-
string
The name of the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginUpdate(string, string, IoTSpacesPatchDescription, RequestOptionsBase)
Update the metadata of a IoTSpaces instance.
function beginUpdate(resourceGroupName: string, resourceName: string, iotSpacePatchDescription: IoTSpacesPatchDescription, options?: RequestOptionsBase): Promise<LROPoller>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.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
checkNameAvailability(OperationInputs, RequestOptionsBase)
Check if an IoTSpaces instance name is available.
function checkNameAvailability(operationInputs: OperationInputs, options?: RequestOptionsBase): Promise<IoTSpacesCheckNameAvailabilityResponse>Parameters
- operationInputs
- OperationInputs
Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<Models.IoTSpacesCheckNameAvailabilityResponse>
checkNameAvailability(OperationInputs, RequestOptionsBase, ServiceCallback<IoTSpacesNameAvailabilityInfo>)
function checkNameAvailability(operationInputs: OperationInputs, options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesNameAvailabilityInfo>)Parameters
- operationInputs
- OperationInputs
Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesNameAvailabilityInfo>
The callback
checkNameAvailability(OperationInputs, ServiceCallback<IoTSpacesNameAvailabilityInfo>)
function checkNameAvailability(operationInputs: OperationInputs, callback: ServiceCallback<IoTSpacesNameAvailabilityInfo>)Parameters
- operationInputs
- OperationInputs
Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesNameAvailabilityInfo>
The callback
createOrUpdate(string, string, IoTSpacesDescription, RequestOptionsBase)
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.
function createOrUpdate(resourceGroupName: string, resourceName: string, iotSpaceDescription: IoTSpacesDescription, options?: RequestOptionsBase): Promise<IoTSpacesCreateOrUpdateResponse>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.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesCreateOrUpdateResponse>
Promise<Models.IoTSpacesCreateOrUpdateResponse>
deleteMethod(string, string, RequestOptionsBase)
Delete an IoTSpaces instance.
function deleteMethod(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<IoTSpacesDeleteMethodResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- resourceName
-
string
The name of the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesDeleteMethodResponse>
Promise<Models.IoTSpacesDeleteMethodResponse>
get(string, string, RequestOptionsBase)
Get the metadata of a IoTSpaces instance.
function get(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<IoTSpacesGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- resourceName
-
string
The name of the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesGetResponse>
Promise<Models.IoTSpacesGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<IoTSpacesDescription>)
function get(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesDescription>)Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- resourceName
-
string
The name of the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescription>
The callback
get(string, string, ServiceCallback<IoTSpacesDescription>)
function get(resourceGroupName: string, resourceName: string, callback: ServiceCallback<IoTSpacesDescription>)Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- resourceName
-
string
The name of the IoTSpaces instance.
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescription>
The callback
list(RequestOptionsBase)
Get all the IoTSpaces instances in a subscription.
function list(options?: RequestOptionsBase): Promise<IoTSpacesListResponse>Parameters
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesListResponse>
Promise<Models.IoTSpacesListResponse>
list(RequestOptionsBase, ServiceCallback<IoTSpacesDescriptionListResult>)
function list(options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
list(ServiceCallback<IoTSpacesDescriptionListResult>)
function list(callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listByResourceGroup(string, RequestOptionsBase)
Get all the IoTSpaces instances in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: RequestOptionsBase): Promise<IoTSpacesListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesListByResourceGroupResponse>
Promise<Models.IoTSpacesListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<IoTSpacesDescriptionListResult>)
function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listByResourceGroup(string, ServiceCallback<IoTSpacesDescriptionListResult>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- resourceGroupName
-
string
The name of the resource group that contains the IoTSpaces instance.
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listByResourceGroupNext(string, RequestOptionsBase)
Get all the IoTSpaces instances in a resource group.
function listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<IoTSpacesListByResourceGroupNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<Models.IoTSpacesListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<IoTSpacesDescriptionListResult>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listByResourceGroupNext(string, ServiceCallback<IoTSpacesDescriptionListResult>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listNext(string, RequestOptionsBase)
Get all the IoTSpaces instances in a subscription.
function listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<IoTSpacesListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesListNextResponse>
Promise<Models.IoTSpacesListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<IoTSpacesDescriptionListResult>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
listNext(string, ServiceCallback<IoTSpacesDescriptionListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<IoTSpacesDescriptionListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
-
@azure/ms-rest-js.ServiceCallback<IoTSpacesDescriptionListResult>
The callback
update(string, string, IoTSpacesPatchDescription, RequestOptionsBase)
Update the metadata of a IoTSpaces instance.
function update(resourceGroupName: string, resourceName: string, iotSpacePatchDescription: IoTSpacesPatchDescription, options?: RequestOptionsBase): Promise<IoTSpacesUpdateResponse>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.
- options
- @azure/ms-rest-js.RequestOptionsBase
The optional parameters
Returns
Promise<IoTSpacesUpdateResponse>
Promise<Models.IoTSpacesUpdateResponse>