CertificateReference Class

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

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.batch._serialization.Model

CertificateReference

Constructor

CertificateReference(*, id: str, store_location: str | _models.CertificateStoreLocation | None = None, store_name: str | None = None, visibility: List[str | _models.CertificateVisibility] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. Required.
store_location	str or CertificateStoreLocation 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. Known values are: "CurrentUser" and "LocalMachine".
store_name	str 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	list[str or CertificateVisibility] Which user accounts on the compute node should have access to the private data of the certificate.

Variables

Name	Description
id	str The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. Required.
store_location	str or CertificateStoreLocation 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. Known values are: "CurrentUser" and "LocalMachine".
store_name	str 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	list[str or CertificateVisibility] Which user accounts on the compute node should have access to the private data of the certificate.