IPoolOperations.StopResizeWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.Batch

Assembly:: Microsoft.Azure.Management.Batch.dll

Package:: Microsoft.Azure.Management.Batch v15.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Stops an ongoing resize operation on the pool.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Batch.Models.Pool,Microsoft.Azure.Management.Batch.Models.PoolStopResizeHeaders>> StopResizeWithHttpMessagesAsync (string resourceGroupName, string accountName, string poolName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StopResizeWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Batch.Models.Pool, Microsoft.Azure.Management.Batch.Models.PoolStopResizeHeaders>>

Public Function StopResizeWithHttpMessagesAsync (resourceGroupName As String, accountName As String, poolName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Pool, PoolStopResizeHeaders))

Parameters

resourceGroupName: String

The name of the resource group that contains the Batch account.

accountName: String

The name of the Batch account.

poolName: String

The pool name. This must be unique within the account.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<Pool,PoolStopResizeHeaders>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

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.

Applies to

Share via