DeletePool interface
Methods
| delete(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. |
| get(Get |
Gets information about the specified Pool. |
| head(Pool |
Gets basic properties of a Pool. |
| patch(Update |
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. |
Method Details
delete(DeletePoolParameters)
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 delete(options?: DeletePoolParameters): StreamableMethod<DeletePool202Response | DeletePoolDefaultResponse>Parameters
- options
- DeletePoolParameters
Returns
get(GetPoolParameters)
Gets information about the specified Pool.
function get(options?: GetPoolParameters): StreamableMethod<GetPool200Response | GetPoolDefaultResponse>Parameters
- options
- GetPoolParameters
Returns
head(PoolExistsParameters)
Gets basic properties of a Pool.
function head(options?: PoolExistsParameters): StreamableMethod<PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse>Parameters
- options
- PoolExistsParameters
Returns
patch(UpdatePoolParameters)
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(options: UpdatePoolParameters): StreamableMethod<UpdatePool200Response | UpdatePoolDefaultResponse>Parameters
- options
- UpdatePoolParameters
