PrivateEndpointConnectionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:private_endpoint_connection> attribute.

Inheritance
builtins.object
PrivateEndpointConnectionOperations

Constructor

PrivateEndpointConnectionOperations(*args, **kwargs)

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) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

account_name
Required
str

The name of the Batch account. Required.

private_endpoint_connection_name
Required
str

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

Returns

Type Description

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

Exceptions

Type Description

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: _models.PrivateEndpointConnection, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

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

account_name
Required
str

The name of the Batch account. Required.

private_endpoint_connection_name
Required
str

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

parameters
Required

PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

if_match
Required
str

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.

Returns

Type Description

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

Exceptions

Type Description

get

Gets information about the specified private endpoint connection.

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

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

account_name
Required
str

The name of the Batch account. Required.

private_endpoint_connection_name
Required
str

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

Returns

Type Description

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description

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: int | None = None, **kwargs: Any) -> Iterable[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
str

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

account_name
Required
str

The name of the Batch account. Required.

maxresults
Required
int

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

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

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