PrivateEndpointsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:private_endpoints> attribute.

Inheritance

builtins.object

PrivateEndpointsOperations

Constructor

PrivateEndpointsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an private endpoint in the specified resource group.
begin_delete	Deletes the specified private endpoint.
get	Gets the specified private endpoint by resource group.
list	Gets all private endpoints in a resource group.
list_by_subscription	Gets all private endpoints in a subscription.

begin_create_or_update

Creates or updates an private endpoint in the specified resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_endpoint_name Required	str The name of the private endpoint. Required.
parameters Required	PrivateEndpoint or IO[bytes] Parameters supplied to the create or update private endpoint operation. Is either a PrivateEndpoint type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PrivateEndpoint]	An instance of LROPoller that returns either PrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified private endpoint.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_endpoint_name Required	str The name of the private endpoint. Required.

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 the specified private endpoint by resource group.

get(resource_group_name: str, private_endpoint_name: str, *, expand: str | None = None, **kwargs: Any) -> PrivateEndpoint

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_endpoint_name Required	str The name of the private endpoint. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PrivateEndpoint	PrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all private endpoints in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[PrivateEndpoint]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[PrivateEndpoint]	An iterator like instance of either PrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets all private endpoints in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[PrivateEndpoint]

Returns

Type	Description
ItemPaged[PrivateEndpoint]	An iterator like instance of either PrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>