azure.mgmt.digitaltwins.operations module

class azure.mgmt.digitaltwins.operations.DigitalTwinsEndpointOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s digital_twins_endpoint attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, endpoint_name: str, endpoint_description: _models.DigitalTwinsEndpointResource, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DigitalTwinsEndpointResource]

begin_create_or_update(resource_group_name: str, resource_name: str, endpoint_name: str, endpoint_description: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DigitalTwinsEndpointResource]

Create or update DigitalTwinsInstance endpoint.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• endpoint_name (str) – Name of Endpoint Resource. Required.

• endpoint_description (DigitalTwinsEndpointResource or IO[bytes]) – The DigitalTwinsInstance endpoint metadata and security metadata. Is either a DigitalTwinsEndpointResource type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[DigitalTwinsEndpointResource]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, endpoint_name: str, **kwargs: Any) → LROPoller[DigitalTwinsEndpointResource]

Delete a DigitalTwinsInstance endpoint.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• endpoint_name (str) – Name of Endpoint Resource. Required.

Returns:

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

Return type:

LROPoller[DigitalTwinsEndpointResource]

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, endpoint_name: str, **kwargs: Any) → DigitalTwinsEndpointResource

Get DigitalTwinsInstances Endpoint.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• endpoint_name (str) – Name of Endpoint Resource. Required.

Returns:

DigitalTwinsEndpointResource or the result of cls(response)

Return type:

DigitalTwinsEndpointResource

Raises:

HttpResponseError –

list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[DigitalTwinsEndpointResource]

Get DigitalTwinsInstance Endpoints.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

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

Return type:

ItemPaged[DigitalTwinsEndpointResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>

class azure.mgmt.digitaltwins.operations.DigitalTwinsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s digital_twins attribute.

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]

begin_create_or_update(resource_group_name: str, resource_name: str, digital_twins_create: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DigitalTwinsDescription]

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:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• digital_twins_create (DigitalTwinsDescription or IO[bytes]) – The DigitalTwinsInstance and security metadata. Is either a DigitalTwinsDescription type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[DigitalTwinsDescription]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → LROPoller[DigitalTwinsDescription]

Delete a DigitalTwinsInstance.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

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

Return type:

LROPoller[DigitalTwinsDescription]

Raises:

HttpResponseError –

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]

begin_update(resource_group_name: str, resource_name: str, digital_twins_patch_description: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DigitalTwinsDescription]

Update metadata of DigitalTwinsInstance.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• digital_twins_patch_description (DigitalTwinsPatchDescription or IO[bytes]) – The DigitalTwinsInstance and security metadata. Is either a DigitalTwinsPatchDescription type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[DigitalTwinsDescription]

Raises:

HttpResponseError –

check_name_availability(location: str, digital_twins_instance_check_name: _models.CheckNameRequest, *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameResult

check_name_availability(location: str, digital_twins_instance_check_name: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.CheckNameResult

Check if a DigitalTwinsInstance name is available.

Parameters:

• location (str) – Location of DigitalTwinsInstance. Required.

• digital_twins_instance_check_name (CheckNameRequest or IO[bytes]) – Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check. Is either a CheckNameRequest type or a IO[bytes] type. Required.

Returns:

CheckNameResult or the result of cls(response)

Return type:

CheckNameResult

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, **kwargs: Any) → DigitalTwinsDescription

Get DigitalTwinsInstances resource.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

DigitalTwinsDescription or the result of cls(response)

Return type:

DigitalTwinsDescription

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[DigitalTwinsDescription]

Get all the DigitalTwinsInstances in a subscription.

Returns:

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

Return type:

ItemPaged[DigitalTwinsDescription]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[DigitalTwinsDescription]

Get all the DigitalTwinsInstances in a resource group.

Parameters:

resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

Returns:

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

Return type:

ItemPaged[DigitalTwinsDescription]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>

class azure.mgmt.digitaltwins.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation]

Lists all of the available DigitalTwins service REST API operations.

Returns:

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

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>

class azure.mgmt.digitaltwins.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

begin_create_or_update(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Update the status of a private endpoint connection with the given name.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

• private_endpoint_connection (PrivateEndpointConnection or IO[bytes]) – The private endpoint connection with updated properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[PrivateEndpointConnection]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None]

Delete private endpoint connection with the specified name.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection

Get private endpoint connection properties for the given private endpoint.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list(resource_group_name: str, resource_name: str, **kwargs: Any) → PrivateEndpointConnectionsResponse

List private endpoint connection properties.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

PrivateEndpointConnectionsResponse or the result of cls(response)

Return type:

PrivateEndpointConnectionsResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>

class azure.mgmt.digitaltwins.operations.PrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s private_link_resources attribute.

get(resource_group_name: str, resource_name: str, resource_id: str, **kwargs: Any) → GroupIdInformation

Get the specified private link resource for the given Digital Twin.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• resource_id (str) – The name of the private link resource. Required.

Returns:

GroupIdInformation or the result of cls(response)

Return type:

GroupIdInformation

Raises:

HttpResponseError –

list(resource_group_name: str, resource_name: str, **kwargs: Any) → GroupIdInformationResponse

List private link resources for given Digital Twin.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

GroupIdInformationResponse or the result of cls(response)

Return type:

GroupIdInformationResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>

class azure.mgmt.digitaltwins.operations.TimeSeriesDatabaseConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDigitalTwinsManagementClient’s time_series_database_connections attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, time_series_database_connection_description: _models.TimeSeriesDatabaseConnection, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.TimeSeriesDatabaseConnection]

begin_create_or_update(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, time_series_database_connection_description: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.TimeSeriesDatabaseConnection]

Create or update a time series database connection.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• time_series_database_connection_name (str) – Name of time series database connection. Required.

• time_series_database_connection_description (TimeSeriesDatabaseConnection or IO[bytes]) – The time series database connection description. Is either a TimeSeriesDatabaseConnection type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[TimeSeriesDatabaseConnection]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, cleanup_connection_artifacts: str | CleanupConnectionArtifacts | None = None, **kwargs: Any) → LROPoller[TimeSeriesDatabaseConnection]

Delete a time series database connection.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• time_series_database_connection_name (str) – Name of time series database connection. Required.

• cleanup_connection_artifacts (str or CleanupConnectionArtifacts) – Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to ‘true’ does not delete any recorded data. Known values are: “true” and “false”. Default value is None.

Returns:

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

Return type:

LROPoller[TimeSeriesDatabaseConnection]

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, **kwargs: Any) → TimeSeriesDatabaseConnection

Get the description of an existing time series database connection.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

• time_series_database_connection_name (str) – Name of time series database connection. Required.

Returns:

TimeSeriesDatabaseConnection or the result of cls(response)

Return type:

TimeSeriesDatabaseConnection

Raises:

HttpResponseError –

list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[TimeSeriesDatabaseConnection]

Get all existing time series database connections for this DigitalTwins instance.

Parameters:

• resource_group_name (str) – The name of the resource group that contains the DigitalTwinsInstance. Required.

• resource_name (str) – The name of the DigitalTwinsInstance. Required.

Returns:

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

Return type:

ItemPaged[TimeSeriesDatabaseConnection]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.digitaltwins.models' from '/mnt/vss/_work/1/s/sdk/digitaltwins/azure-mgmt-digitaltwins/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/digitaltwins/models/__init__.py'>