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.

async begin_delete(resource_group_name: str, vault_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[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.

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

get

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

async 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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[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.

async 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 The intended state of private endpoint connection. 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

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'>