PrivateEndpointConnectionOperations Class

PrivateEndpointConnectionOperations 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

PrivateEndpointConnectionOperations

Constructor

PrivateEndpointConnectionOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

begin_delete	Deletes the specified private endpoint connection.
begin_update	Updates the properties of an existing private endpoint connection.
get	Gets information about the specified private endpoint connection.
list_by_batch_account	Lists all of the private endpoint connections in the specified account.

begin_delete

Deletes the specified private endpoint connection.

begin_delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the Batch account.

account_name

str

Required

The name of the Batch account.

private_endpoint_connection_name

str

Required

The private endpoint connection name. This must be unique within the account.

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

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Updates the properties of an existing private endpoint connection.

begin_update(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.batch.models._models_py3.PrivateEndpointConnection, if_match: Optional[str] = None, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.batch.models._models_py3.PrivateEndpointConnection]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the Batch account.

account_name

str

Required

The name of the Batch account.

private_endpoint_connection_name

str

Required

The private endpoint connection name. This must be unique within the account.

parameters

PrivateEndpointConnection

Required

PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

if_match

str

Required

The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally. Default value is None.

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

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

Return type

LROPoller[PrivateEndpointConnection]

Exceptions

HttpResponseError

get

Gets information about the specified private endpoint connection.

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> azure.mgmt.batch.models._models_py3.PrivateEndpointConnection

Parameters

resource_group_name

str

Required

The name of the resource group that contains the Batch account.

account_name

str

Required

The name of the Batch account.

private_endpoint_connection_name

str

Required

The private endpoint connection name. This must be unique within the account.

cls

callable

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

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Exceptions

HttpResponseError

list_by_batch_account

Lists all of the private endpoint connections in the specified account.

list_by_batch_account(resource_group_name: str, account_name: str, maxresults: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.batch.models._models_py3.ListPrivateEndpointConnectionsResult]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the Batch account.

account_name

str

Required

The name of the Batch account.

maxresults

int

Required

The maximum number of items to return in the response. Default value is None.

cls

callable

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

Returns

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

Return type

ItemPaged[ListPrivateEndpointConnectionsResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>