CertificateReference interface

Package:

@azure/arm-batch

Warning: This object is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

Properties

id	The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
storeLocation	The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). 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.
storeName	This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.
visibility	Which user accounts on the compute node should have access to the private data of the certificate.

Property Details

id

The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.

id: string

Property Value

string

storeLocation

The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). 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.

storeLocation?: CertificateStoreLocation

Property Value

CertificateStoreLocation

storeName

This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

storeName?: string

Property Value

string

visibility

Which user accounts on the compute node should have access to the private data of the certificate.

visibility?: CertificateVisibility[]

Property Value

CertificateVisibility[]