PoolOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:pool> attribute.

Constructor

PoolOperations(*args, **kwargs)

Methods

begin_delete	Deletes the specified pool.
create	Creates a new pool inside the specified account.
disable_auto_scale	Disables automatic scaling for a pool.
get	Gets information about the specified pool.
list_by_batch_account	Lists all of the pools in the specified account.
stop_resize	Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
update	Updates the properties of an existing pool.

begin_delete

Deletes the specified pool.

async begin_delete(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> AsyncLROPoller[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.
pool_name Required	str The pool name. This must be unique within the account. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

create

Creates a new pool inside the specified account.

async create(resource_group_name: str, account_name: str, pool_name: str, parameters: _models.Pool, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.Pool

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.
pool_name Required	str The pool name. This must be unique within the account. Required.
parameters Required	Pool or <xref:JSON> or IO[bytes] Additional parameters for pool creation. Is one of the following types: Pool, 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
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

disable_auto_scale

Disables automatic scaling for a pool.

async disable_auto_scale(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

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.
pool_name Required	str The pool name. This must be unique within the account. Required.

Returns

Type	Description
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Gets information about the specified pool.

async get(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

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.
pool_name Required	str The pool name. This must be unique within the account. Required.

Returns

Type	Description
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_batch_account

Lists all of the pools in the specified account.

list_by_batch_account(resource_group_name: str, account_name: str, *, maxresults: int | None = None, select: str | None = None, filter: str | None = None, **kwargs: Any) -> AsyncItemPaged[Pool]

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
select	str Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. Default value is None. Default value: None
filter	str OData filter expression. Valid properties for filtering are: name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[Pool]	An iterator like instance of Pool

Exceptions

Type	Description
HttpResponseError

stop_resize

Stops an ongoing resize operation on the pool.

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

async stop_resize(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> Pool

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.
pool_name Required	str The pool name. This must be unique within the account. Required.

Returns

Type	Description
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

update

Updates the properties of an existing pool.

async update(resource_group_name: str, account_name: str, pool_name: str, parameters: _models.Pool, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.Pool

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.
pool_name Required	str The pool name. This must be unique within the account. Required.
parameters Required	Pool or <xref:JSON> or IO[bytes] Pool 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: Pool, 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
Pool	Pool. The Pool is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError