DigitalTwinsOperations Class
DigitalTwinsOperations async 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.objectDigitalTwinsOperations
Constructor
DigitalTwinsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
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.
async begin_create_or_update(resource_group_name: str, resource_name: str, digital_twins_create: azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescription, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescription]Parameters
- resource_group_name
- str
The name of the resource group that contains the DigitalTwinsInstance.
- digital_twins_create
- DigitalTwinsDescription
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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either DigitalTwinsDescription or the result of cls(response)
Return type
Exceptions
begin_delete
Delete a DigitalTwinsInstance.
async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescription]Parameters
- resource_group_name
- str
The name of the resource group that contains 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either DigitalTwinsDescription or the result of cls(response)
Return type
Exceptions
begin_update
Update metadata of DigitalTwinsInstance.
async begin_update(resource_group_name: str, resource_name: str, digital_twins_patch_description: azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsPatchDescription, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescription]Parameters
- resource_group_name
- str
The name of the resource group that contains the DigitalTwinsInstance.
- digital_twins_patch_description
- DigitalTwinsPatchDescription
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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either DigitalTwinsDescription or the result of cls(response)
Return type
Exceptions
check_name_availability
Check if a DigitalTwinsInstance name is available.
async check_name_availability(location: str, digital_twins_instance_check_name: azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.CheckNameRequest, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.CheckNameResultParameters
- digital_twins_instance_check_name
- CheckNameRequest
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
get
Get DigitalTwinsInstances resource.
async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescriptionParameters
- resource_group_name
- str
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
DigitalTwinsDescription, or the result of cls(response)
Return type
Exceptions
list
Get all the DigitalTwinsInstances in a subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.digitaltwins.v2020_12_01.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
Exceptions
list_by_resource_group
Get all the DigitalTwinsInstances in a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.digitaltwins.v2020_12_01.models._models_py3.DigitalTwinsDescriptionListResult]Parameters
- resource_group_name
- str
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
Attributes
models
models = <module 'azure.mgmt.digitaltwins.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\digitaltwins\\v2020_12_01\\models\\__init__.py'>Feedback
Submit and view feedback for