TimeSeriesDatabaseConnectionsOperations Class

TimeSeriesDatabaseConnectionsOperations 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

TimeSeriesDatabaseConnectionsOperations

Constructor

TimeSeriesDatabaseConnectionsOperations(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 a time series database connection.
begin_delete	Delete a time series database connection.
get	Get the description of an existing time series database connection.
list	Get all existing time series database connections for this DigitalTwins instance.

begin_create_or_update

Create or update a time series database connection.

begin_create_or_update(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, time_series_database_connection_description: azure.mgmt.digitaltwins.v2021_06_30_preview.models._models_py3.TimeSeriesDatabaseConnection, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.digitaltwins.v2021_06_30_preview.models._models_py3.TimeSeriesDatabaseConnection]

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.

time_series_database_connection_name

str

Required

Name of time series database connection.

time_series_database_connection_description

TimeSeriesDatabaseConnection

Required

The time series database connection 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

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

Return type

LROPoller[TimeSeriesDatabaseConnection]

Exceptions

HttpResponseError

begin_delete

Delete a time series database connection.

begin_delete(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.digitaltwins.v2021_06_30_preview.models._models_py3.TimeSeriesDatabaseConnection]

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.

time_series_database_connection_name

str

Required

Name of time series database connection.

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

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

Return type

LROPoller[TimeSeriesDatabaseConnection]

Exceptions

HttpResponseError

get

Get the description of an existing time series database connection.

get(resource_group_name: str, resource_name: str, time_series_database_connection_name: str, **kwargs: Any) -> azure.mgmt.digitaltwins.v2021_06_30_preview.models._models_py3.TimeSeriesDatabaseConnection

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.

time_series_database_connection_name

str

Required

Name of time series database connection.

cls

callable

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

Returns

TimeSeriesDatabaseConnection, or the result of cls(response)

Return type

TimeSeriesDatabaseConnection

Exceptions

HttpResponseError

list

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

list(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[azure.mgmt.digitaltwins.v2021_06_30_preview.models._models_py3.TimeSeriesDatabaseConnectionListResult]

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

Return type

ItemPaged[TimeSeriesDatabaseConnectionListResult]

Exceptions

HttpResponseError

Attributes

models

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