Skip to main content

pool

Overview

Namepool
TypeResource
Idazure.batch.pool

Fields

NameDatatypeDescription
idstringThe ID of the resource.
namestringThe name of the resource.
etagstringThe ETag of the resource, used for concurrency statements.
identityobjectThe identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities
propertiesobjectPool properties.
typestringThe type of the resource.

Methods

NameAccessible byRequired ParamsDescription
getSELECTaccountName, poolName, resourceGroupName, subscriptionIdGets information about the specified pool.
list_by_batch_accountSELECTaccountName, resourceGroupName, subscriptionIdLists all of the pools in the specified account.
createINSERTaccountName, poolName, resourceGroupName, subscriptionIdCreates a new pool inside the specified account.
deleteDELETEaccountName, poolName, resourceGroupName, subscriptionIdDeletes the specified pool.
_list_by_batch_accountEXECaccountName, resourceGroupName, subscriptionIdLists all of the pools in the specified account.
disable_auto_scaleEXECaccountName, poolName, resourceGroupName, subscriptionIdDisables automatic scaling for a pool.
stop_resizeEXECaccountName, poolName, resourceGroupName, subscriptionIdThis 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.
updateEXECaccountName, poolName, resourceGroupName, subscriptionIdUpdates the properties of an existing pool.