Share via

AffinityInformation.AffinityId Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch.Protocol.Models
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
AffinityInformation.cs

Gets or sets an opaque string representing the location of a Compute Node or a Task that has run previously.

[Newtonsoft.Json.JsonProperty(PropertyName="affinityId")]
public string AffinityId { get; set; }
[<Newtonsoft.Json.JsonProperty(PropertyName="affinityId")>]
member this.AffinityId : string with get, set
Public Property AffinityId As String

Property Value

String
Attributes
Newtonsoft.Json.JsonPropertyAttribute

Remarks

You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.

Applies to