DigitalTwinsEndpointOperations Class

DigitalTwinsEndpointOperations 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.object

DigitalTwinsEndpointOperations

Constructor

DigitalTwinsEndpointOperations(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 DigitalTwinsInstance endpoint.
begin_delete	Delete a DigitalTwinsInstance endpoint.
get	Get DigitalTwinsInstances Endpoint.
list	Get DigitalTwinsInstance Endpoints.

begin_create_or_update

Create or update DigitalTwinsInstance endpoint.

async begin_create_or_update(resource_group_name: str, resource_name: str, endpoint_name: str, endpoint_description: azure.mgmt.digitaltwins.v2020_03_01_preview.models._models_py3.DigitalTwinsEndpointResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.digitaltwins.v2020_03_01_preview.models._models_py3.DigitalTwinsEndpointResource]

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.

endpoint_name

str

Required

Name of Endpoint Resource.

endpoint_description

DigitalTwinsEndpointResource

Required

The DigitalTwinsInstance endpoint metadata 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 DigitalTwinsEndpointResource or the result of cls(response)

Return type

AsyncLROPoller[DigitalTwinsEndpointResource]

Exceptions

HttpResponseError

begin_delete

Delete a DigitalTwinsInstance endpoint.

async begin_delete(resource_group_name: str, resource_name: str, endpoint_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.digitaltwins.v2020_03_01_preview.models._models_py3.DigitalTwinsEndpointResource]

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.

endpoint_name

str

Required

Name of Endpoint Resource.

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 DigitalTwinsEndpointResource or the result of cls(response)

Return type

AsyncLROPoller[DigitalTwinsEndpointResource]

Exceptions

HttpResponseError

get

Get DigitalTwinsInstances Endpoint.

async get(resource_group_name: str, resource_name: str, endpoint_name: str, **kwargs: Any) -> azure.mgmt.digitaltwins.v2020_03_01_preview.models._models_py3.DigitalTwinsEndpointResource

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.

endpoint_name

str

Required

Name of Endpoint Resource.

cls

callable

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

Returns

DigitalTwinsEndpointResource, or the result of cls(response)

Return type

DigitalTwinsEndpointResource

Exceptions

HttpResponseError

list

Get DigitalTwinsInstance Endpoints.

list(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.digitaltwins.v2020_03_01_preview.models._models_py3.DigitalTwinsEndpointResourceListResult]

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

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

Return type

AsyncItemPaged[DigitalTwinsEndpointResourceListResult]

Exceptions

HttpResponseError

Attributes

models

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