DigitalTwinsOperations Class

DigitalTwinsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
DigitalTwinsOperations

Constructor

DigitalTwinsOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

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

Delete a DigitalTwinsInstance.

begin_update

Update metadata of DigitalTwinsInstance.

check_name_availability

Check if a DigitalTwinsInstance name is available.

get

Get DigitalTwinsInstances resource.

list

Get all the DigitalTwinsInstances in a subscription.

list_by_resource_group

Get all the DigitalTwinsInstances in a resource group.

begin_create_or_update

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(resource_group_name, resource_name, digital_twins_create, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group that contains the DigitalTwinsInstance.

resource_name
str
Required

The name of the DigitalTwinsInstance.

digital_twins_create
DigitalTwinsDescription
Required

The DigitalTwinsInstance and security metadata.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Delete a DigitalTwinsInstance.

begin_delete(resource_group_name, resource_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group that contains the DigitalTwinsInstance.

resource_name
str
Required

The name of the DigitalTwinsInstance.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update

Update metadata of DigitalTwinsInstance.

begin_update(resource_group_name, resource_name, digital_twins_patch_description, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group that contains the DigitalTwinsInstance.

resource_name
str
Required

The name of the DigitalTwinsInstance.

digital_twins_patch_description
DigitalTwinsPatchDescription
Required

The DigitalTwinsInstance and security metadata.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

check_name_availability

Check if a DigitalTwinsInstance name is available.

check_name_availability(location, digital_twins_instance_check_name, **kwargs)

Parameters

location
str
Required

Location of DigitalTwinsInstance.

digital_twins_instance_check_name
CheckNameRequest
Required

Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.

cls
callable

A custom type or function that will be passed the direct response

Returns

CheckNameResult, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

Get DigitalTwinsInstances resource.

get(resource_group_name, resource_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group that contains the DigitalTwinsInstance.

resource_name
str
Required

The name of the DigitalTwinsInstance.

cls
callable

A custom type or function that will be passed the direct response

Returns

DigitalTwinsDescription, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list

Get all the DigitalTwinsInstances in a subscription.

list(**kwargs)

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DigitalTwinsDescriptionListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Get all the DigitalTwinsInstances in a resource group.

list_by_resource_group(resource_group_name, **kwargs)

Parameters

resource_group_name
str
Required

The name of the resource group that contains the DigitalTwinsInstance.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DigitalTwinsDescriptionListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.digitaltwins.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\digitaltwins\\v2020_12_01\\models\\__init__.py'>