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.

begin_create_or_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

account_name

str

Required

Cosmos DB database account name.

private_endpoint_connection_name

str

Required

The name of the private endpoint connection.

parameters

PrivateEndpointConnection

Required

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 PollingMethod

By default, your polling method will be ARMPolling. 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

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

Return type

LROPoller[PrivateEndpointConnection]

Exceptions

HttpResponseError

begin_delete

Deletes a private endpoint connection with a given name.

begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

account_name

str

Required

Cosmos DB database account name.

private_endpoint_connection_name

str

Required

The name of the private endpoint connection.

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 PollingMethod

By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

Gets a private endpoint connection.

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnection

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

account_name

str

Required

Cosmos DB database account name.

private_endpoint_connection_name

str

Required

The name of the private endpoint connection.

cls

callable

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

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Exceptions

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) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.PrivateEndpointConnectionListResult]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

account_name

str

Required

Cosmos DB database account name.

cls

callable

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

Returns

An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnectionListResult]

Exceptions

HttpResponseError

Attributes

models

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