PrivateEndpointConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:private_endpoint_connections> attribute.

Inheritance

builtins.object

PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

Methods

begin_create_or_update	Approve or reject a private endpoint connection with a given name.
begin_delete	Deletes a private endpoint connection with a given name.
get	Gets a private endpoint connection.
list_by_database_account	List all private endpoint connections on a Cosmos DB account.

begin_create_or_update

Approve or reject a private endpoint connection with a given name.

async begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: _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. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.
parameters Required	PrivateEndpointConnection or IO[bytes] Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a private endpoint connection with a given name.

async begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a private endpoint connection.

async get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
private_endpoint_connection_name Required	str The name of the private endpoint connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_database_account

List all private endpoint connections on a Cosmos DB account.

list_by_database_account(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[PrivateEndpointConnection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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