DigitalTwins | @azure/arm-digitaltwins

Interface representing a DigitalTwins.

Hierarchy

DigitalTwins

Implemented by

DigitalTwinsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsCreateOrUpdateResponse>, DigitalTwinsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/digitalTwins.ts:68
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.

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.
- Optional options: DigitalTwinsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DigitalTwinsCreateOrUpdateResponse>, DigitalTwinsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsCreateOrUpdateResponse>

- Defined in operationsInterfaces/digitalTwins.ts:88
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.

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.
- Optional options: DigitalTwinsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DigitalTwinsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsDeleteResponse>, DigitalTwinsDeleteResponse>>

- Defined in operationsInterfaces/digitalTwins.ts:131
Delete a DigitalTwinsInstance.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the DigitalTwinsInstance.
- resourceName: string
  
  The name of the DigitalTwinsInstance.
- Optional options: DigitalTwinsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DigitalTwinsDeleteResponse>, DigitalTwinsDeleteResponse>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDeleteResponse>

- Defined in operationsInterfaces/digitalTwins.ts:147
Delete a DigitalTwinsInstance.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the DigitalTwinsInstance.
- resourceName: string
  
  The name of the DigitalTwinsInstance.
- Optional options: DigitalTwinsDeleteOptionalParams
  
  The options parameters.
Returns Promise<DigitalTwinsDeleteResponse>

beginUpdate

beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DigitalTwinsUpdateResponse>, DigitalTwinsUpdateResponse>>

- Defined in operationsInterfaces/digitalTwins.ts:101
Update metadata of DigitalTwinsInstance.

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.
- Optional options: DigitalTwinsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DigitalTwinsUpdateResponse>, DigitalTwinsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>

- Defined in operationsInterfaces/digitalTwins.ts:119
Update metadata of DigitalTwinsInstance.

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.
- Optional options: DigitalTwinsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DigitalTwinsUpdateResponse>

checkNameAvailability

checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<DigitalTwinsCheckNameAvailabilityResponse>

- Defined in operationsInterfaces/digitalTwins.ts:159
Check if a DigitalTwinsInstance name is available.

Parameters
- location: string
  
  Location of DigitalTwinsInstance.
- digitalTwinsInstanceCheckName: CheckNameRequest
  
  Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.
- Optional options: DigitalTwinsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<DigitalTwinsCheckNameAvailabilityResponse>

get

get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsGetResponse>

- Defined in operationsInterfaces/digitalTwins.ts:54
Get DigitalTwinsInstances resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the DigitalTwinsInstance.
- resourceName: string
  
  The name of the DigitalTwinsInstance.
- Optional options: DigitalTwinsGetOptionalParams
  
  The options parameters.
Returns Promise<DigitalTwinsGetResponse>

list

list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>

- Defined in operationsInterfaces/digitalTwins.ts:36
Get all the DigitalTwinsInstances in a subscription.

Parameters
- Optional options: DigitalTwinsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DigitalTwinsDescription>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription>

- Defined in operationsInterfaces/digitalTwins.ts:44
Get all the DigitalTwinsInstances in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the DigitalTwinsInstance.
- Optional options: DigitalTwinsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DigitalTwinsDescription>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

digitalTwinsCreate: DigitalTwinsDescription

Optional options: DigitalTwinsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DigitalTwinsCreateOrUpdateResponse>, DigitalTwinsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

digitalTwinsCreate: DigitalTwinsDescription

Optional options: DigitalTwinsCreateOrUpdateOptionalParams

Returns Promise<DigitalTwinsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: DigitalTwinsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<DigitalTwinsDeleteResponse>, DigitalTwinsDeleteResponse>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: DigitalTwinsDeleteOptionalParams

Returns Promise<DigitalTwinsDeleteResponse>

beginUpdate

Parameters

resourceGroupName: string

resourceName: string

digitalTwinsPatchDescription: DigitalTwinsPatchDescription

Optional options: DigitalTwinsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DigitalTwinsUpdateResponse>, DigitalTwinsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

digitalTwinsPatchDescription: DigitalTwinsPatchDescription

Optional options: DigitalTwinsUpdateOptionalParams

Returns Promise<DigitalTwinsUpdateResponse>

checkNameAvailability

Parameters

location: string

digitalTwinsInstanceCheckName: CheckNameRequest

Optional options: DigitalTwinsCheckNameAvailabilityOptionalParams

Returns Promise<DigitalTwinsCheckNameAvailabilityResponse>

get

Parameters

resourceGroupName: string

resourceName: string

Optional options: DigitalTwinsGetOptionalParams

Returns Promise<DigitalTwinsGetResponse>

list

Parameters

Optional options: DigitalTwinsListOptionalParams

Returns PagedAsyncIterableIterator<DigitalTwinsDescription>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: DigitalTwinsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<DigitalTwinsDescription>