PrivateEndpointConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

KeyVaultManagementClient's

<xref:private_endpoint_connections> attribute.

Inheritance

builtins.object

PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

Methods

begin_delete	Deletes the specified private endpoint connection associated with the key vault.
get	Gets the specified private endpoint connection associated with the key vault.
list_by_resource	The List operation gets information about the private endpoint connections associated with the vault.
put	Updates the specified private endpoint connection associated with the key vault.

begin_delete

Deletes the specified private endpoint connection associated with the key vault.

begin_delete(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> LROPoller[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group that contains the key vault. Required.
vault_name Required	str The name of the key vault. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection associated with the key vault. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the specified private endpoint connection associated with the key vault.

get(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection | None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group that contains the key vault. Required.
vault_name Required	str The name of the key vault. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection associated with the key vault. Required.

Returns

Type	Description
PrivateEndpointConnection, None	PrivateEndpointConnection or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource

The List operation gets information about the private endpoint connections associated with the vault.

list_by_resource(resource_group_name: str, vault_name: str, **kwargs: Any) -> Iterable[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group that contains the key vault. Required.
vault_name Required	str The name of the key vault. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

put

Updates the specified private endpoint connection associated with the key vault.

put(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateEndpointConnection

Parameters

Name	Description
resource_group_name Required	str Name of the resource group that contains the key vault. Required.
vault_name Required	str The name of the key vault. Required.
private_endpoint_connection_name Required	str Name of the private endpoint connection associated with the key vault. Required.
properties Required	PrivateEndpointConnection or IO[bytes] The intended state of private endpoint connection. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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