Share via

PrivateEndpointConnectionsOperations Class

  • Reference

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.

Inheritance
builtins.object
PrivateEndpointConnectionsOperations

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_delete

Delete a specific private endpoint connection.

Delete a specific private endpoint connection under a topic, domain, or partner namespace.
begin_update

Update a specific private endpoint connection.

Update a specific private endpoint connection under a topic, domain or partner namespace.
get

Get a specific private endpoint connection.

Get a specific private endpoint connection under a topic, domain, or partner namespace.
list_by_resource

Lists all private endpoint connections under a resource.

Get all private endpoint connections under a topic, domain, or partner namespace.

begin_delete

Delete a specific private endpoint connection.

Delete a specific private endpoint connection under a topic, domain, or partner namespace.

begin_delete(resource_group_name: str, parent_type: str | PrivateEndpointConnectionsParentType, parent_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 within the user's subscription.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name
Required
str

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
private_endpoint_connection_name
Required
str

The name of the private endpoint connection connection.

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

Update a specific private endpoint connection.

Update a specific private endpoint connection under a topic, domain or partner namespace.

begin_update(resource_group_name: str, parent_type: str | PrivateEndpointConnectionsParentType, parent_name: str, private_endpoint_connection_name: str, private_endpoint_connection: PrivateEndpointConnection, **kwargs: Any) -> LROPoller[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name
Required
str

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
private_endpoint_connection_name
Required
str

The name of the private endpoint connection connection.
private_endpoint_connection
Required
PrivateEndpointConnection

The private endpoint connection object to update.

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

Get a specific private endpoint connection.

Get a specific private endpoint connection under a topic, domain, or partner namespace.

get(resource_group_name: str, parent_type: str | PrivateEndpointConnectionsParentType, parent_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name
Required
str

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
private_endpoint_connection_name
Required
str

The name of the private endpoint connection 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_resource

Lists all private endpoint connections under a resource.

Get all private endpoint connections under a topic, domain, or partner namespace.

list_by_resource(resource_group_name: str, parent_type: str | PrivateEndpointConnectionsParentType, parent_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PrivateEndpointConnectionListResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
parent_name
Required
str

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
filter
Required
str

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
top
Required
int

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

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.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>