DigitalTwinsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AzureDigitalTwinsManagementClient's
<xref:digital_twins> attribute.
- Inheritance
-
builtins.objectDigitalTwinsOperations
Constructor
DigitalTwinsOperations(*args, **kwargs)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: str, resource_name: str, digital_twins_create: _models.DigitalTwinsDescription, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DigitalTwinsDescription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the DigitalTwinsInstance. Required. |
|
resource_name
Required
|
The name of the DigitalTwinsInstance. Required. |
|
digital_twins_create
Required
|
The DigitalTwinsInstance and security metadata. Is either a DigitalTwinsDescription type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete a DigitalTwinsInstance.
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[DigitalTwinsDescription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the DigitalTwinsInstance. Required. |
|
resource_name
Required
|
The name of the DigitalTwinsInstance. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update metadata of DigitalTwinsInstance.
begin_update(resource_group_name: str, resource_name: str, digital_twins_patch_description: _models.DigitalTwinsPatchDescription, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DigitalTwinsDescription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the DigitalTwinsInstance. Required. |
|
resource_name
Required
|
The name of the DigitalTwinsInstance. Required. |
|
digital_twins_patch_description
Required
|
The DigitalTwinsInstance and security metadata. Is either a DigitalTwinsPatchDescription type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
check_name_availability
Check if a DigitalTwinsInstance name is available.
check_name_availability(location: str, digital_twins_instance_check_name: _models.CheckNameRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameResultParameters
| Name | Description |
|---|---|
|
location
Required
|
Location of DigitalTwinsInstance. Required. |
|
digital_twins_instance_check_name
Required
|
Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check. Is either a CheckNameRequest type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
CheckNameResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get DigitalTwinsInstances resource.
get(resource_group_name: str, resource_name: str, **kwargs: Any) -> DigitalTwinsDescriptionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the DigitalTwinsInstance. Required. |
|
resource_name
Required
|
The name of the DigitalTwinsInstance. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Get all the DigitalTwinsInstances in a subscription.
list(**kwargs: Any) -> Iterable[DigitalTwinsDescription]Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Get all the DigitalTwinsInstances in a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DigitalTwinsDescription]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the DigitalTwinsInstance. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DigitalTwinsDescription or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.digitaltwins.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\digitaltwins\\v2020_12_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for