Share via

PrivateEndpointConnectionsOperations Class

PrivateEndpointConnectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Constructor

PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

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

Updates tags on private endpoint connection.

Updates private endpoint connection with the specified tags.
get

Gets a private endpoint connection.
list_by_server

Gets all private endpoint connections on a server.

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: '_models.PrivateEndpointConnection', **kwargs: Any) -> LROPoller['_models.PrivateEndpointConnection']

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server.
private_endpoint_connection_name
Required
str
parameters
Required
PrivateEndpointConnection

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[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, server_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.
server_name
Required
str

The name of the server.
private_endpoint_connection_name
Required
str

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

begin_update_tags

Updates tags on private endpoint connection.

Updates private endpoint connection with the specified tags.

begin_update_tags(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: '_models.TagsObject', **kwargs: Any) -> LROPoller['_models.PrivateEndpointConnection']

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server.
private_endpoint_connection_name
Required
str
parameters
Required
TagsObject

Parameters supplied to the Update private endpoint connection Tags operation.

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[PrivateEndpointConnection]

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

Exceptions

Type Description
HttpResponseError

get

Gets a private endpoint connection.

get(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> _models.PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection.

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_server

Gets all private endpoint connections on a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable['_models.PrivateEndpointConnectionListResult']

Parameters

Name Description
resource_group_name
Required
str

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

The name of the server.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[PrivateEndpointConnectionListResult]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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