PrivateEndpointConnectionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:private_endpoint_connections> attribute.
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.
begin_delete(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> LROPoller[PrivateEndpointConnection]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the IoT hub. Required. |
|
resource_name
Required
|
The name of the IoT hub. Required. |
|
private_endpoint_connection_name
Required
|
The name of the private endpoint connection. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update private endpoint connection.
Update the status of a private endpoint connection with the specified name.
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) -> LROPoller[_models.PrivateEndpointConnection]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the IoT hub. Required. |
|
resource_name
Required
|
The name of the IoT hub. Required. |
|
private_endpoint_connection_name
Required
|
The name of the private endpoint connection. Required. |
|
private_endpoint_connection
Required
|
The private endpoint connection with updated properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get private endpoint connection.
Get private endpoint connection properties.
get(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnectionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the IoT hub. Required. |
|
resource_name
Required
|
The name of the IoT hub. Required. |
|
private_endpoint_connection_name
Required
|
The name of the private endpoint connection. Required. |
Returns
| Type | Description |
|---|---|
|
PrivateEndpointConnection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List private endpoint connections.
List private endpoint connection properties.
list(resource_group_name: str, resource_name: str, **kwargs: Any) -> List[PrivateEndpointConnection]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the IoT hub. Required. |
|
resource_name
Required
|
The name of the IoT hub. Required. |
Returns
| Type | Description |
|---|---|
|
list of PrivateEndpointConnection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.iothub.v2023_06_30_preview.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv151\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30_preview\\models\\__init__.py'>