PrivateEndpointConnectionsOperations Class

PrivateEndpointConnectionsOperations 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

PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(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_delete	Delete private endpoint connection. Delete private endpoint connection with the specified name.
begin_update	Update private endpoint connection. Update the status of a private endpoint connection with the specified name.
get	Get private endpoint connection. Get private endpoint connection properties.
list	List private endpoint connections. List private endpoint connection properties.

begin_delete

Delete private endpoint connection.

Delete private endpoint connection with the specified name.

async begin_delete(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothub.v2020_03_01.models._models_py3.PrivateEndpointConnection]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the IoT hub.

resource_name

str

Required

The name of the IoT hub.

private_endpoint_connection_name

str

Required

The name of the private endpoint 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 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 PrivateEndpointConnection or the result of cls(response)

Return type

AsyncLROPoller[PrivateEndpointConnection]

Exceptions

HttpResponseError

begin_update

Update private endpoint connection.

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

async begin_update(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, private_endpoint_connection: azure.mgmt.iothub.v2020_03_01.models._models_py3.PrivateEndpointConnection, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.iothub.v2020_03_01.models._models_py3.PrivateEndpointConnection]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the IoT hub.

resource_name

str

Required

The name of the IoT hub.

private_endpoint_connection_name

str

Required

The name of the private endpoint connection.

private_endpoint_connection

PrivateEndpointConnection

Required

The private endpoint connection with updated properties.

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

Return type

AsyncLROPoller[PrivateEndpointConnection]

Exceptions

HttpResponseError

get

Get private endpoint connection.

Get private endpoint connection properties.

async get(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.iothub.v2020_03_01.models._models_py3.PrivateEndpointConnection

Parameters

resource_group_name

str

Required

The name of the resource group that contains the IoT hub.

resource_name

str

Required

The name of the IoT hub.

private_endpoint_connection_name

str

Required

The name of the private endpoint connection.

cls

callable

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

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Exceptions

HttpResponseError

list

List private endpoint connections.

List private endpoint connection properties.

async list(resource_group_name: str, resource_name: str, **kwargs: Any) -> List[azure.mgmt.iothub.v2020_03_01.models._models_py3.PrivateEndpointConnection]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the IoT hub.

resource_name

str

Required

The name of the IoT hub.

cls

callable

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

Returns

list of PrivateEndpointConnection, or the result of cls(response)

Return type

list[PrivateEndpointConnection]

Exceptions

HttpResponseError

Attributes

models

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