PoolInformation.PoolId Property

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

PoolInformation.cs

Gets or sets the ID of an existing Pool. All the Tasks of the Job will run on the specified Pool.

[Newtonsoft.Json.JsonProperty(PropertyName="poolId")]
public string PoolId { get; set; }

[<Newtonsoft.Json.JsonProperty(PropertyName="poolId")>]
member this.PoolId : string with get, set

Public Property PoolId As String

Property Value

String

Attributes

Newtonsoft.Json.JsonPropertyAttribute

Remarks

You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both.