Package version
Create a Pool.
Reference to the service client.
When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
The pool to be added.
Promise<Models.PoolAddResponse>
The pool to be added.
The callback
The pool to be added.
The optional parameters
The callback
When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
The ID of the pool to delete.
Promise<Models.PoolDeleteResponse>
The ID of the pool to delete.
The callback
The ID of the pool to delete.
The optional parameters
The callback
The ID of the pool on which to disable automatic scaling.
Promise<Models.PoolDisableAutoScaleResponse>
The ID of the pool on which to disable automatic scaling.
The callback
The ID of the pool on which to disable automatic scaling.
The optional parameters
The callback
You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
The ID of the pool on which to enable automatic scaling.
The parameters for the request.
Promise<Models.PoolEnableAutoScaleResponse>
The ID of the pool on which to enable automatic scaling.
The parameters for the request.
The callback
The ID of the pool on which to enable automatic scaling.
The parameters for the request.
The optional parameters
The callback
This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
The ID of the pool on which to evaluate the automatic scaling formula.
The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
Promise<Models.PoolEvaluateAutoScaleResponse>
The ID of the pool on which to evaluate the automatic scaling formula.
The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
The callback
The ID of the pool on which to evaluate the automatic scaling formula.
The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
The optional parameters
The callback
Gets basic properties of a pool.
The ID of the pool to get.
Promise<Models.PoolExistsResponse>
The ID of the pool to get.
The callback
The ID of the pool to get.
The optional parameters
The callback
Gets information about the specified pool.
The ID of the pool to get.
Promise<Models.PoolGetResponse>
The ID of the pool to get.
The callback
The ID of the pool to get.
The optional parameters
The callback
Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Promise<Models.PoolGetAllLifetimeStatisticsResponse>
The callback
The optional parameters
The callback
Promise<Models.PoolListResponse>
The callback
The optional parameters
The callback
The NextLink from the previous successful call to List operation.
Promise<Models.PoolListResponse>
The NextLink from the previous successful call to List operation.
The callback
The NextLink from the previous successful call to List operation.
The optional parameters
The callback
If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Promise<Models.PoolListUsageMetricsResponse>
The callback
The optional parameters
The callback
If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
The NextLink from the previous successful call to List operation.
Promise<Models.PoolListUsageMetricsResponse>
The NextLink from the previous successful call to List operation.
The callback
The NextLink from the previous successful call to List operation.
The optional parameters
The callback
This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
The ID of the pool to update.
The parameters for the request.
Promise<Models.PoolPatchResponse>
The ID of the pool to update.
The parameters for the request.
The callback
The ID of the pool to update.
The parameters for the request.
The optional parameters
The callback
This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
The ID of the pool from which you want to remove nodes.
The parameters for the request.
Promise<Models.PoolRemoveNodesResponse>
The ID of the pool from which you want to remove nodes.
The parameters for the request.
The callback
The ID of the pool from which you want to remove nodes.
The parameters for the request.
The optional parameters
The callback
You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
The ID of the pool to resize.
The parameters for the request.
Promise<Models.PoolResizeResponse>
The ID of the pool to resize.
The parameters for the request.
The callback
The ID of the pool to resize.
The parameters for the request.
The optional parameters
The callback
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.
The ID of the pool whose resizing you want to stop.
Promise<Models.PoolStopResizeResponse>
The ID of the pool whose resizing you want to stop.
The callback
The ID of the pool whose resizing you want to stop.
The optional parameters
The callback
This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
The ID of the pool to update.
The parameters for the request.
Promise<Models.PoolUpdatePropertiesResponse>
The ID of the pool to update.
The parameters for the request.
The callback
The ID of the pool to update.
The parameters for the request.
The optional parameters
The callback
Generated using TypeDoc
Class representing a Pool.