PoolPatchParameter.CertificateReferences Property

Definition

Namespace:

Microsoft.Azure.Batch.Protocol.Models

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

PoolPatchParameter.cs

Gets or sets a list of Certificates to be installed on each Compute Node in the Pool.

[Newtonsoft.Json.JsonProperty(PropertyName="certificateReferences")]
public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> CertificateReferences { get; set; }

[<Newtonsoft.Json.JsonProperty(PropertyName="certificateReferences")>]
member this.CertificateReferences : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> with get, set

Public Property CertificateReferences As IList(Of CertificateReference)

Property Value

IList<CertificateReference>

Attributes

Newtonsoft.Json.JsonPropertyAttribute

Remarks

If this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.

Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.