Package com.azure.resourcemanager.batch.models

Class CertificateReference

java.lang.Object
com.azure.resourcemanager.batch.models.CertificateReference
public final class CertificateReference extends Object
A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.

Warning: This object 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.

  • Constructor Details

    • CertificateReference

      public CertificateReference()
      Creates an instance of CertificateReference class.

  • Method Details

    • id

      public String id()
      Get the id property: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
      Returns:
      the id value.

    • withId

      public CertificateReference withId(String id)
      Set the id property: The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.
      Parameters:
      id - the id value to set.
      Returns:
      the CertificateReference object itself.

    • storeLocation

      public CertificateStoreLocation storeLocation()
      Get the storeLocation property: The location of the certificate store on the compute node into which to install the certificate.

      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.

      Returns:
      the storeLocation value.

    • withStoreLocation

      public CertificateReference withStoreLocation(CertificateStoreLocation storeLocation)
      Set the storeLocation property: The location of the certificate store on the compute node into which to install the certificate.

      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.

      Parameters:
      storeLocation - the storeLocation value to set.
      Returns:
      the CertificateReference object itself.

    • storeName

      public String storeName()
      Get the storeName property: The name of the certificate store on the compute node into which to install the certificate.

      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.

      Returns:
      the storeName value.

    • withStoreName

      public CertificateReference withStoreName(String storeName)
      Set the storeName property: The name of the certificate store on the compute node into which to install the certificate.

      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.

      Parameters:
      storeName - the storeName value to set.
      Returns:
      the CertificateReference object itself.

    • visibility

      public List<CertificateVisibility> visibility()
      Get the visibility property: Which user accounts on the compute node should have access to the private data of the certificate.
      Returns:
      the visibility value.

    • withVisibility

      public CertificateReference withVisibility(List<CertificateVisibility> visibility)
      Set the visibility property: Which user accounts on the compute node should have access to the private data of the certificate.
      Parameters:
      visibility - the visibility value to set.
      Returns:
      the CertificateReference object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.