PoolOperationsExtensions.UpdateProperties Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: PoolOperationsExtensions.cs

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.

Updates the properties of the specified Pool.

public static Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesHeaders UpdateProperties (this Microsoft.Azure.Batch.Protocol.IPoolOperations operations, string poolId, Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesOptions poolUpdatePropertiesOptions = default);

static member UpdateProperties : Microsoft.Azure.Batch.Protocol.IPoolOperations * string * Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter * Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesOptions -> Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesHeaders

<Extension()>
Public Function UpdateProperties (operations As IPoolOperations, poolId As String, poolUpdatePropertiesParameter As PoolUpdatePropertiesParameter, Optional poolUpdatePropertiesOptions As PoolUpdatePropertiesOptions = Nothing) As 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

Returns

PoolUpdatePropertiesHeaders

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