Share via

PrivateEndpointConnectionOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:private_endpoint_connection> attribute.

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. The name is case insensitive. Required.
account_name
Required
str

A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
private_endpoint_connection_name
Required
str

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

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns None

Exceptions

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
private_endpoint_connection_name
Required
str

The private endpoint connection name. This must be unique within the account. Required.
parameters
Required
PrivateEndpointConnection or <xref:JSON> or IO[bytes]

PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. Is one of the following types: PrivateEndpointConnection, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name Description
etag
str

check if resource is changed. Set None to skip checking etag. Default value is None.

Default value: None
match_condition
MatchConditions

The match condition to use upon the etag. Default value is None.

Default value: None

Returns

Type Description
LROPoller[PrivateEndpointConnection]

An instance of LROPoller that returns PrivateEndpointConnection. The PrivateEndpointConnection is compatible with MutableMapping

Exceptions

Type Description
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) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.
private_endpoint_connection_name
Required
str

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

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection. The PrivateEndpointConnection is compatible with MutableMapping

Exceptions

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/. Required.

Keyword-Only Parameters

Name Description
maxresults
int

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

Default value: None

Returns

Type Description
ItemPaged[PrivateEndpointConnection]

An iterator like instance of PrivateEndpointConnection

Exceptions

Type Description
HttpResponseError