Share via

BatchAccountOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:batch_account> attribute.

Constructor

BatchAccountOperations(*args, **kwargs)

Methods

begin_create

Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
begin_delete

Deletes the specified Batch account.
get

Gets information about the specified Batch account.
get_detector

Gets information about the given detector for a given Batch account.
get_keys

Gets the account keys for the specified Batch account.

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
list

Gets information about the Batch accounts associated with the subscription.
list_by_resource_group

Gets information about the Batch accounts associated with the specified resource group.
list_detectors

Gets information about the detectors available for a given Batch account.
list_outbound_network_dependencies_endpoints

Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.
regenerate_key

Regenerates the specified account key for the Batch account.

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.
synchronize_auto_storage_keys

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
update

Updates the properties of an existing Batch account.

begin_create

Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.

begin_create(resource_group_name: str, account_name: str, parameters: _models.BatchAccountCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BatchAccount]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. 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.
parameters
Required
BatchAccountCreateParameters or IO[bytes]

Additional parameters for account creation. Is either a BatchAccountCreateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[BatchAccount]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified Batch account.

begin_delete(resource_group_name: str, account_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.

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 information about the specified Batch account.

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

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.

Returns

Type Description
BatchAccount

BatchAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_detector

Gets information about the given detector for a given Batch account.

get_detector(resource_group_name: str, account_name: str, detector_id: str, **kwargs: Any) -> DetectorResponse

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.
detector_id
Required
str

The name of the detector. Required.

Returns

Type Description
DetectorResponse

DetectorResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_keys

Gets the account keys for the specified Batch account.

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.

get_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> BatchAccountKeys

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.

Returns

Type Description
BatchAccountKeys

BatchAccountKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets information about the Batch accounts associated with the subscription.

list(**kwargs: Any) -> Iterable[BatchAccount]

Returns

Type Description
ItemPaged[BatchAccount]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Gets information about the Batch accounts associated with the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[BatchAccount]

Parameters

Name Description
resource_group_name
Required
str

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

Returns

Type Description
ItemPaged[BatchAccount]

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

Exceptions

Type Description
HttpResponseError

list_detectors

Gets information about the detectors available for a given Batch account.

list_detectors(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[DetectorResponse]

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.

Returns

Type Description
ItemPaged[DetectorResponse]

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

Exceptions

Type Description
HttpResponseError

list_outbound_network_dependencies_endpoints

Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.

list_outbound_network_dependencies_endpoints(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[OutboundEnvironmentEndpoint]

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.

Returns

Type Description
ItemPaged[OutboundEnvironmentEndpoint]

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

Exceptions

Type Description
HttpResponseError

regenerate_key

Regenerates the specified account key for the Batch account.

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.

regenerate_key(resource_group_name: str, account_name: str, parameters: _models.BatchAccountRegenerateKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BatchAccountKeys

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.
parameters
Required
BatchAccountRegenerateKeyParameters or IO[bytes]

The type of key to regenerate. Is either a BatchAccountRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns

Type Description
BatchAccountKeys

BatchAccountKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError

synchronize_auto_storage_keys

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.

synchronize_auto_storage_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> 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.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Updates the properties of an existing Batch account.

update(resource_group_name: str, account_name: str, parameters: _models.BatchAccountUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BatchAccount

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.
parameters
Required
BatchAccountUpdateParameters or IO[bytes]

Additional parameters for account update. Is either a BatchAccountUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
BatchAccount

BatchAccount or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.batch.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv79\\Lib\\site-packages\\azure\\mgmt\\batch\\models\\__init__.py'>