Share via

PrivateEndpointConnectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

IotHubClient's

<xref:private_endpoint_connections> attribute.

Inheritance
builtins.object
PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

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) -> AsyncLROPoller[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the IoT hub. Required.
resource_name
Required
str

The name of the IoT hub. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection. 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 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

Type Description
AsyncLROPoller[PrivateEndpointConnection]

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

Exceptions

Type Description
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: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the IoT hub. Required.
resource_name
Required
str

The name of the IoT hub. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection. Required.
private_endpoint_connection
Required
PrivateEndpointConnection or IO

The private endpoint connection with updated properties. Is either a PrivateEndpointConnection 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 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

Type Description
AsyncLROPoller[PrivateEndpointConnection]

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

Exceptions

Type Description
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) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the IoT hub. Required.
resource_name
Required
str

The name of the IoT hub. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List private endpoint connections.

List private endpoint connection properties.

async list(resource_group_name: str, resource_name: str, **kwargs: Any) -> List[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the IoT hub. Required.
resource_name
Required
str

The name of the IoT hub. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
list[PrivateEndpointConnection]

list of PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.iothub.v2023_06_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30\\models\\__init__.py'>