DigitalTwins interface
Interface representing a DigitalTwins.
Methods
| begin |
Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. |
| begin |
Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance. |
| begin |
Delete a DigitalTwinsInstance. |
| begin |
Delete a DigitalTwinsInstance. |
| begin |
Update metadata of DigitalTwinsInstance. |
| begin |
Update metadata of DigitalTwinsInstance. |
| check |
Check if a DigitalTwinsInstance name is available. |
| get(string, string, Digital |
Get DigitalTwinsInstances resource. |
| list(Digital |
Get all the DigitalTwinsInstances in a subscription. |
| list |
Get all the DigitalTwinsInstances in a resource group. |
Method Details
beginCreateOrUpdate(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)
Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- digitalTwinsCreate
- DigitalTwinsDescription
The DigitalTwinsInstance and security metadata.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginCreateOrUpdateAndWait(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)
Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- digitalTwinsCreate
- DigitalTwinsDescription
The DigitalTwinsInstance and security metadata.
The options parameters.
Returns
Promise<DigitalTwinsDescription>
beginDelete(string, string, DigitalTwinsDeleteOptionalParams)
Delete a DigitalTwinsInstance.
function beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- options
- DigitalTwinsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginDeleteAndWait(string, string, DigitalTwinsDeleteOptionalParams)
Delete a DigitalTwinsInstance.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- options
- DigitalTwinsDeleteOptionalParams
The options parameters.
Returns
Promise<DigitalTwinsDescription>
beginUpdate(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)
Update metadata of DigitalTwinsInstance.
function beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- digitalTwinsPatchDescription
- DigitalTwinsPatchDescription
The DigitalTwinsInstance and security metadata.
- options
- DigitalTwinsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginUpdateAndWait(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)
Update metadata of DigitalTwinsInstance.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- digitalTwinsPatchDescription
- DigitalTwinsPatchDescription
The DigitalTwinsInstance and security metadata.
- options
- DigitalTwinsUpdateOptionalParams
The options parameters.
Returns
Promise<DigitalTwinsDescription>
checkNameAvailability(string, CheckNameRequest, DigitalTwinsCheckNameAvailabilityOptionalParams)
Check if a DigitalTwinsInstance name is available.
function checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>Parameters
- location
-
string
Location of DigitalTwinsInstance.
- digitalTwinsInstanceCheckName
- CheckNameRequest
Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.
The options parameters.
Returns
Promise<CheckNameResult>
get(string, string, DigitalTwinsGetOptionalParams)
Get DigitalTwinsInstances resource.
function get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
- resourceName
-
string
The name of the DigitalTwinsInstance.
- options
- DigitalTwinsGetOptionalParams
The options parameters.
Returns
Promise<DigitalTwinsDescription>
list(DigitalTwinsListOptionalParams)
Get all the DigitalTwinsInstances in a subscription.
function list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>Parameters
- options
- DigitalTwinsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, DigitalTwinsListByResourceGroupOptionalParams)
Get all the DigitalTwinsInstances in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the DigitalTwinsInstance.
The options parameters.