PoolOperationsExtensions.PatchAsync(IPoolOperations, String, PoolPatchParameter, PoolPatchOptions, CancellationToken) Method

Definition

Updates the properties of the specified Pool.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolPatchHeaders> PatchAsync (this Microsoft.Azure.Batch.Protocol.IPoolOperations operations, string poolId, Microsoft.Azure.Batch.Protocol.Models.PoolPatchParameter poolPatchParameter, Microsoft.Azure.Batch.Protocol.Models.PoolPatchOptions poolPatchOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member PatchAsync : Microsoft.Azure.Batch.Protocol.IPoolOperations * string * Microsoft.Azure.Batch.Protocol.Models.PoolPatchParameter * Microsoft.Azure.Batch.Protocol.Models.PoolPatchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolPatchHeaders>
<Extension()>
Public Function PatchAsync (operations As IPoolOperations, poolId As String, poolPatchParameter As PoolPatchParameter, Optional poolPatchOptions As PoolPatchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PoolPatchHeaders)

Parameters

operations
IPoolOperations

The operations group for this extension method.

poolId
String

The ID of the Pool to update.

poolPatchParameter
PoolPatchParameter

The parameters for the request.

poolPatchOptions
PoolPatchOptions

Additional parameters for the operation

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<PoolPatchHeaders>

Remarks

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.

Applies to