DigitalTwinsEndpointOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AzureDigitalTwinsManagementClient's

<xref:digital_twins_endpoint> attribute.

Inheritance

builtins.object

DigitalTwinsEndpointOperations

Constructor

DigitalTwinsEndpointOperations(*args, **kwargs)

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.

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]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name Required	str The name of the DigitalTwinsInstance. Required.
endpoint_name Required	str Name of Endpoint Resource. Required.
endpoint_description Required	DigitalTwinsEndpointResource or IO The DigitalTwinsInstance endpoint metadata and security metadata. Is either a DigitalTwinsEndpointResource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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

Type	Description
LROPoller[DigitalTwinsEndpointResource]	An instance of LROPoller that returns either DigitalTwinsEndpointResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a DigitalTwinsInstance endpoint.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name Required	str The name of the DigitalTwinsInstance. Required.
endpoint_name Required	str Name of Endpoint Resource. Required.

Keyword-Only Parameters

Name	Description
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

Type	Description
LROPoller[DigitalTwinsEndpointResource]	An instance of LROPoller that returns either DigitalTwinsEndpointResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get DigitalTwinsInstances Endpoint.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name Required	str The name of the DigitalTwinsInstance. Required.
endpoint_name Required	str Name of Endpoint Resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DigitalTwinsEndpointResource	DigitalTwinsEndpointResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get DigitalTwinsInstance Endpoints.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name Required	str The name of the DigitalTwinsInstance. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[DigitalTwinsEndpointResource]	An iterator like instance of either DigitalTwinsEndpointResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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'>