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.
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.
update	Update metadata of DigitalTwinsInstance.

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: str, resource_name: str, digital_twins_create: azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescription, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescription]

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

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

LROPoller[DigitalTwinsDescription]

Exceptions

HttpResponseError

begin_delete

Delete a DigitalTwinsInstance.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescription]

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

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in 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

LROPoller[DigitalTwinsDescription]

Exceptions

HttpResponseError

check_name_availability

Check if a DigitalTwinsInstance name is available.

check_name_availability(location: str, digital_twins_instance_check_name: azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.CheckNameRequest, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.CheckNameResult

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

CheckNameResult

Exceptions

HttpResponseError

get

Get DigitalTwinsInstances resource.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescription

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

DigitalTwinsDescription

Exceptions

HttpResponseError

list

Get all the DigitalTwinsInstances in a subscription.

list(**kwargs: Any) -> Iterable[azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescriptionListResult]

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

ItemPaged[DigitalTwinsDescriptionListResult]

Exceptions

HttpResponseError

list_by_resource_group

Get all the DigitalTwinsInstances in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescriptionListResult]

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

ItemPaged[DigitalTwinsDescriptionListResult]

Exceptions

HttpResponseError

update

Update metadata of DigitalTwinsInstance.

update(resource_group_name: str, resource_name: str, digital_twins_patch_description: azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsPatchDescription, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_10_31.models._models_py3.DigitalTwinsDescription

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

Returns

DigitalTwinsDescription, or the result of cls(response)

Return type

DigitalTwinsDescription

Exceptions

HttpResponseError

Attributes

models

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