Share via


PoolOperationsExtensions.UpdatePropertiesAsync Method

Definition

Updates the properties of the specified Pool.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesHeaders> UpdatePropertiesAsync (this Microsoft.Azure.Batch.Protocol.IPoolOperations operations, string poolId, Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesOptions poolUpdatePropertiesOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member UpdatePropertiesAsync : Microsoft.Azure.Batch.Protocol.IPoolOperations * string * Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter * Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesHeaders>
<Extension()>
Public Function UpdatePropertiesAsync (operations As IPoolOperations, poolId As String, poolUpdatePropertiesParameter As PoolUpdatePropertiesParameter, Optional poolUpdatePropertiesOptions As PoolUpdatePropertiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PoolUpdatePropertiesHeaders)

Parameters

operations
IPoolOperations

The operations group for this extension method.

poolId
String

The ID of the Pool to update.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

The parameters for the request.

poolUpdatePropertiesOptions
PoolUpdatePropertiesOptions

Additional parameters for the operation

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

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.

Applies to