Share via

PrivateEndpointConnectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:private_endpoint_connections> attribute.

Inheritance
builtins.object
PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

Methods

begin_delete

Delete a specific private endpoint connection.

Delete a specific private endpoint connection under a topic, domain, or partner namespace or 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 or namespace.
list_by_resource

Lists all private endpoint connections under a resource.

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

begin_delete

Delete a specific private endpoint connection.

Delete a specific private endpoint connection under a topic, domain, or partner namespace or 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. Required.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'. Known values are: "topics", "domains", "partnerNamespaces", and "namespaces". Required.
parent_name
Required
str

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

The name of the private endpoint connection connection. Required.

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 | _models.PrivateEndpointConnectionsParentType, parent_name: str, private_endpoint_connection_name: str, private_endpoint_connection: _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 within the user's subscription. Required.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'. Known values are: "topics", "domains", "partnerNamespaces", and "namespaces". Required.
parent_name
Required
str

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

The name of the private endpoint connection connection. Required.
private_endpoint_connection
Required
PrivateEndpointConnection or IO[bytes]

The private endpoint connection object to update. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

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 or 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. Required.
parent_type
Required
str or PrivateEndpointConnectionsParentType

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'. Known values are: "topics", "domains", "partnerNamespaces", and "namespaces". Required.
parent_name
Required
str

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

The name of the private endpoint connection connection. Required.

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

Parameters

Name Description
resource_group_name
Required
str

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

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'. Known values are: "topics", "domains", "partnerNamespaces", and "namespaces". Required.
parent_name
Required
str

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name). Required.
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.

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