Pool class
Class representing a Pool.
Constructors
| Pool(Batch |
Create a Pool. |
Methods
| add(Pool |
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. |
| add(Pool |
|
| add(Pool |
|
| delete |
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 Compute Nodes; any Tasks running on existing Compute 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. |
| delete |
|
| delete |
|
| disable |
|
| disable |
|
| disable |
|
| enable |
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. |
| enable |
|
| enable |
|
| evaluate |
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. |
| evaluate |
|
| evaluate |
|
| exists(string, Pool |
Gets basic properties of a Pool. |
| exists(string, Pool |
|
| exists(string, Service |
|
| get(string, Pool |
Gets information about the specified Pool. |
| get(string, Pool |
|
| get(string, Service |
|
| get |
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. |
| get |
|
| get |
|
| list(Pool |
|
| list(Pool |
|
| list(Service |
|
| list |
|
| list |
|
| list |
|
| list |
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. |
| list |
|
| list |
|
| list |
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. |
| list |
|
| list |
|
| patch(string, Pool |
This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask. |
| patch(string, Pool |
|
| patch(string, Pool |
|
| remove |
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. |
| remove |
|
| remove |
|
| resize(string, Pool |
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 Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead. |
| resize(string, Pool |
|
| resize(string, Pool |
|
| stop |
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 Compute 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. |
| stop |
|
| stop |
|
| update |
This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask. |
| update |
|
| update |
Constructor Details
Pool(BatchServiceClientContext)
Create a Pool.
new Pool(client: BatchServiceClientContext)Parameters
- client
- BatchServiceClientContext
Reference to the service client.
Method Details
add(PoolAddParameter, PoolAddOptionalParams)
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.
function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>Parameters
- pool
- PoolAddParameter
The Pool to be added.
- options
- PoolAddOptionalParams
The optional parameters
Returns
Promise<PoolAddResponse>
Promise<Models.PoolAddResponse>
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)Parameters
- pool
- PoolAddParameter
The Pool to be added.
- options
- PoolAddOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
add(PoolAddParameter, ServiceCallback<void>)
function add(pool: PoolAddParameter, callback: ServiceCallback<void>)Parameters
- pool
- PoolAddParameter
The Pool to be added.
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, PoolDeleteMethodOptionalParams)
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 Compute Nodes; any Tasks running on existing Compute 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.
function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>Parameters
- poolId
-
string
The ID of the Pool to delete.
- options
- PoolDeleteMethodOptionalParams
The optional parameters
Returns
Promise<PoolDeleteResponse>
Promise<Models.PoolDeleteResponse>
deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to delete.
- options
- PoolDeleteMethodOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(poolId: string, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to delete.
- callback
-
ServiceCallback<void>
The callback
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>Parameters
- poolId
-
string
The ID of the Pool on which to disable automatic scaling.
The optional parameters
Returns
Promise<PoolDisableAutoScaleResponse>
Promise<Models.PoolDisableAutoScaleResponse>
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool on which to disable automatic scaling.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
disableAutoScale(string, ServiceCallback<void>)
function disableAutoScale(poolId: string, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool on which to disable automatic scaling.
- callback
-
ServiceCallback<void>
The callback
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)
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.
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>Parameters
- poolId
-
string
The ID of the Pool on which to enable automatic scaling.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
The parameters for the request.
The optional parameters
Returns
Promise<PoolEnableAutoScaleResponse>
Promise<Models.PoolEnableAutoScaleResponse>
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool on which to enable automatic scaling.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
The parameters for the request.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool on which to enable automatic scaling.
- poolEnableAutoScaleParameter
- PoolEnableAutoScaleParameter
The parameters for the request.
- callback
-
ServiceCallback<void>
The callback
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)
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.
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>Parameters
- poolId
-
string
The ID of the Pool on which to evaluate the automatic scaling formula.
- autoScaleFormula
-
string
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
Returns
Promise<PoolEvaluateAutoScaleResponse>
Promise<Models.PoolEvaluateAutoScaleResponse>
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)Parameters
- poolId
-
string
The ID of the Pool on which to evaluate the automatic scaling formula.
- autoScaleFormula
-
string
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
- callback
The callback
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)Parameters
- poolId
-
string
The ID of the Pool on which to evaluate the automatic scaling formula.
- autoScaleFormula
-
string
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).
- callback
The callback
exists(string, PoolExistsOptionalParams)
Gets basic properties of a Pool.
function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>Parameters
- poolId
-
string
The ID of the Pool to get.
- options
- PoolExistsOptionalParams
The optional parameters
Returns
Promise<PoolExistsResponse>
Promise<Models.PoolExistsResponse>
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)Parameters
- poolId
-
string
The ID of the Pool to get.
- options
- PoolExistsOptionalParams
The optional parameters
- callback
-
ServiceCallback<boolean>
The callback
exists(string, ServiceCallback<boolean>)
function exists(poolId: string, callback: ServiceCallback<boolean>)Parameters
- poolId
-
string
The ID of the Pool to get.
- callback
-
ServiceCallback<boolean>
The callback
get(string, PoolGetOptionalParams)
Gets information about the specified Pool.
function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>Parameters
- poolId
-
string
The ID of the Pool to get.
- options
- PoolGetOptionalParams
The optional parameters
Returns
Promise<PoolGetResponse>
Promise<Models.PoolGetResponse>
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)Parameters
- poolId
-
string
The ID of the Pool to get.
- options
- PoolGetOptionalParams
The optional parameters
- callback
The callback
get(string, ServiceCallback<CloudPool>)
function get(poolId: string, callback: ServiceCallback<CloudPool>)Parameters
- poolId
-
string
The ID of the Pool to get.
- callback
The callback
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)
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.
function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>Parameters
The optional parameters
Returns
Promise<PoolGetAllLifetimeStatisticsResponse>
Promise<Models.PoolGetAllLifetimeStatisticsResponse>
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)Parameters
The optional parameters
- callback
The callback
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)Parameters
- callback
The callback
list(PoolListOptionalParams)
function list(options?: PoolListOptionalParams): Promise<PoolListResponse>Parameters
- options
- PoolListOptionalParams
The optional parameters
Returns
Promise<PoolListResponse>
Promise<Models.PoolListResponse>
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)Parameters
- options
- PoolListOptionalParams
The optional parameters
- callback
The callback
list(ServiceCallback<CloudPoolListResult>)
function list(callback: ServiceCallback<CloudPoolListResult>)Parameters
- callback
The callback
listNext(string, PoolListNextOptionalParams)
function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- PoolListNextOptionalParams
The optional parameters
Returns
Promise<PoolListResponse>
Promise<Models.PoolListResponse>
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- PoolListNextOptionalParams
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<CloudPoolListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listUsageMetrics(PoolListUsageMetricsOptionalParams)
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.
function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>Parameters
The optional parameters
Returns
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsResponse>
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameters
The optional parameters
- callback
The callback
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)Parameters
- callback
The callback
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)
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.
function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
Returns
Promise<PoolListUsageMetricsResponse>
Promise<Models.PoolListUsageMetricsResponse>
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The optional parameters
- callback
The callback
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
patch(string, PoolPatchParameter, PoolPatchOptionalParams)
This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>Parameters
- poolId
-
string
The ID of the Pool to update.
- poolPatchParameter
- PoolPatchParameter
The parameters for the request.
- options
- PoolPatchOptionalParams
The optional parameters
Returns
Promise<PoolPatchResponse>
Promise<Models.PoolPatchResponse>
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to update.
- poolPatchParameter
- PoolPatchParameter
The parameters for the request.
- options
- PoolPatchOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
patch(string, PoolPatchParameter, ServiceCallback<void>)
function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to update.
- poolPatchParameter
- PoolPatchParameter
The parameters for the request.
- callback
-
ServiceCallback<void>
The callback
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)
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.
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>Parameters
- poolId
-
string
The ID of the Pool from which you want to remove Compute Nodes.
- nodeRemoveParameter
- NodeRemoveParameter
The parameters for the request.
- options
- PoolRemoveNodesOptionalParams
The optional parameters
Returns
Promise<PoolRemoveNodesResponse>
Promise<Models.PoolRemoveNodesResponse>
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool from which you want to remove Compute Nodes.
- nodeRemoveParameter
- NodeRemoveParameter
The parameters for the request.
- options
- PoolRemoveNodesOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool from which you want to remove Compute Nodes.
- nodeRemoveParameter
- NodeRemoveParameter
The parameters for the request.
- callback
-
ServiceCallback<void>
The callback
resize(string, PoolResizeParameter, PoolResizeOptionalParams)
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 Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>Parameters
- poolId
-
string
The ID of the Pool to resize.
- poolResizeParameter
- PoolResizeParameter
The parameters for the request.
- options
- PoolResizeOptionalParams
The optional parameters
Returns
Promise<PoolResizeResponse>
Promise<Models.PoolResizeResponse>
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to resize.
- poolResizeParameter
- PoolResizeParameter
The parameters for the request.
- options
- PoolResizeOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
resize(string, PoolResizeParameter, ServiceCallback<void>)
function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to resize.
- poolResizeParameter
- PoolResizeParameter
The parameters for the request.
- callback
-
ServiceCallback<void>
The callback
stopResize(string, PoolStopResizeOptionalParams)
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 Compute 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.
function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>Parameters
- poolId
-
string
The ID of the Pool whose resizing you want to stop.
- options
- PoolStopResizeOptionalParams
The optional parameters
Returns
Promise<PoolStopResizeResponse>
Promise<Models.PoolStopResizeResponse>
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool whose resizing you want to stop.
- options
- PoolStopResizeOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
stopResize(string, ServiceCallback<void>)
function stopResize(poolId: string, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool whose resizing you want to stop.
- callback
-
ServiceCallback<void>
The callback
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)
This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>Parameters
- poolId
-
string
The ID of the Pool to update.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
The parameters for the request.
The optional parameters
Returns
Promise<PoolUpdatePropertiesResponse>
Promise<Models.PoolUpdatePropertiesResponse>
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to update.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
The parameters for the request.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)
function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)Parameters
- poolId
-
string
The ID of the Pool to update.
- poolUpdatePropertiesParameter
- PoolUpdatePropertiesParameter
The parameters for the request.
- callback
-
ServiceCallback<void>
The callback