PrivateEndpointsOperations Class

PrivateEndpointsOperations async 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

PrivateEndpointsOperations

Constructor

PrivateEndpointsOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.network.v2019_11_01.models._models_py3.PrivateEndpoint, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.PrivateEndpoint')]

Parameters

resource_group_name

str

Required

The name of the resource group.

private_endpoint_name

str

Required

The name of the private endpoint.

parameters

PrivateEndpoint

Required

Parameters supplied to the create or update private endpoint operation.

cls

callable

Required

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

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either PrivateEndpoint or the result of cls(response)

Return type

AsyncLROPoller[PrivateEndpoint]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified private endpoint.

begin_delete(resource_group_name: str, private_endpoint_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The name of the resource group.

private_endpoint_name

str

Required

The name of the private endpoint.

cls

callable

Required

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

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified private endpoint by resource group.

get(resource_group_name: str, private_endpoint_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2019_11_01.models._models_py3.PrivateEndpoint

Parameters

resource_group_name

str

Required

The name of the resource group.

private_endpoint_name

str

Required

The name of the private endpoint.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

PrivateEndpoint, or the result of cls(response)

Return type

PrivateEndpoint

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all private endpoints in a resource group.

list(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.PrivateEndpointListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[PrivateEndpointListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_subscription

Gets all private endpoints in a subscription.

list_by_subscription(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.PrivateEndpointListResult')]

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[PrivateEndpointListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2019_11_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2019_11_01\\models\\__init__.py'>