Package com.microsoft.azure.batch.protocol.models

Class CertificateReference

  • public class CertificateReference
extends Object
    A reference to a Certificate to be installed on Compute Nodes in a Pool.

    • Constructor Detail

      • CertificateReference

        public CertificateReference()

    • Method Detail

      • thumbprint

        public String thumbprint()
        Get the thumbprint value.
        Returns:
        the thumbprint value

      • withThumbprint

        public CertificateReference withThumbprint​(String thumbprint)
        Set the thumbprint value.
        Parameters:
        thumbprint - the thumbprint value to set
        Returns:
        the CertificateReference object itself.

      • thumbprintAlgorithm

        public String thumbprintAlgorithm()
        Get the thumbprintAlgorithm value.
        Returns:
        the thumbprintAlgorithm value

      • withThumbprintAlgorithm

        public CertificateReference withThumbprintAlgorithm​(String thumbprintAlgorithm)
        Set the thumbprintAlgorithm value.
        Parameters:
        thumbprintAlgorithm - the thumbprintAlgorithm value to set
        Returns:
        the CertificateReference object itself.

      • storeLocation

        public CertificateStoreLocation storeLocation()
        Get the default value is currentuser. This property is applicable only for Pools configured with Windows Compute 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. Possible values include: 'currentUser', 'localMachine'.
        Returns:
        the storeLocation value

      • withStoreLocation

        public CertificateReference withStoreLocation​(CertificateStoreLocation storeLocation)
        Set the default value is currentuser. This property is applicable only for Pools configured with Windows Compute 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. Possible values include: 'currentUser', 'localMachine'.
        Parameters:
        storeLocation - the storeLocation value to set
        Returns:
        the CertificateReference object itself.

      • storeName

        public String storeName()
        Get this property is applicable only for Pools configured with Windows Compute 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 this property is applicable only for Pools configured with Windows Compute 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 you can specify more than one visibility in this collection. The default is all Accounts.
        Returns:
        the visibility value

      • withVisibility

        public CertificateReference withVisibility​(List<CertificateVisibility> visibility)
        Set you can specify more than one visibility in this collection. The default is all Accounts.
        Parameters:
        visibility - the visibility value to set
        Returns:
        the CertificateReference object itself.