Share via

PrivateEndpointConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosdbForPostgresqlMgmtClient's

<xref:private_endpoint_connections> attribute.

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Approves or Rejects a private endpoint connection with a given name.
begin_delete

Deletes a private endpoint connection with a given name.
get

Gets private endpoint connection.
list_by_cluster

Gets list of private endpoint connections on a cluster.

begin_create_or_update

Approves or Rejects a private endpoint connection with a given name.

begin_create_or_update(resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
cluster_name
Required
str

The name of the cluster. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the cluster. Required.
parameters
Required
PrivateEndpointConnection or IO

The required parameters for approving a 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
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

Type Description
LROPoller[PrivateEndpointConnection]

An instance of LROPoller 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.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
cluster_name
Required
str

The name of the cluster. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the cluster. 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 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

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets private endpoint connection.

get(resource_group_name: str, cluster_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.
cluster_name
Required
str

The name of the cluster. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection associated with the cluster. Required.

Keyword-Only Parameters

Name Description
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

list_by_cluster

Gets list of private endpoint connections on a cluster.

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
cluster_name
Required
str

The name of the cluster. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[PrivateEndpointConnection]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cosmosdbforpostgresql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv102\\Lib\\site-packages\\azure\\mgmt\\cosmosdbforpostgresql\\models\\__init__.py'>