CertificateReference Class

Package:

com.microsoft.azure.batch.protocol.models

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.CertificateReference

public class CertificateReference

A reference to a certificate to be installed on compute nodes in a pool.

Method Summary

Modifier and Type	Method and Description
CertificateStoreLocation	storeLocation() Get 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. Possible values include: 'currentUser', 'localMachine'.
String	storeName() Get 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.
String	thumbprint() Get the thumbprint value.
String	thumbprintAlgorithm() Get the thumbprintAlgorithm value.
List<CertificateVisibility>	visibility() Get you can specify more than one visibility in this collection. The default is all accounts.
CertificateReference	withStoreLocation(CertificateStoreLocation storeLocation) Set 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. Possible values include: 'currentUser', 'localMachine'.
CertificateReference	withStoreName(String storeName) Set 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.
CertificateReference	withThumbprint(String thumbprint) Set the thumbprint value.
CertificateReference	withThumbprintAlgorithm(String thumbprintAlgorithm) Set the thumbprintAlgorithm value.
CertificateReference	withVisibility(List<CertificateVisibility> visibility) Set you can specify more than one visibility in this collection. The default is all accounts.

Method Details

storeLocation

public CertificateStoreLocation storeLocation()

Get 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. Possible values include: 'currentUser', 'localMachine'.

Returns:

the storeLocation value

storeName

public String storeName()

Get 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

thumbprint

public String thumbprint()

Get the thumbprint value.

Returns:

the thumbprint value

thumbprintAlgorithm

public String thumbprintAlgorithm()

Get the thumbprintAlgorithm value.

Returns:

the thumbprintAlgorithm value

visibility

public List visibility()

Get you can specify more than one visibility in this collection. The default is all accounts.

Returns:

the visibility value

withStoreLocation

public CertificateReference withStoreLocation(CertificateStoreLocation storeLocation)

Set 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. Possible values include: 'currentUser', 'localMachine'.

Parameters:

storeLocation - the storeLocation value to set

Returns:

the CertificateReference object itself.

withStoreName

public CertificateReference withStoreName(String storeName)

Set 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.

withThumbprint

public CertificateReference withThumbprint(String thumbprint)

Set the thumbprint value.

Parameters:

thumbprint - the thumbprint value to set

Returns:

the CertificateReference object itself.

withThumbprintAlgorithm

public CertificateReference withThumbprintAlgorithm(String thumbprintAlgorithm)

Set the thumbprintAlgorithm value.

Parameters:

thumbprintAlgorithm - the thumbprintAlgorithm value to set

Returns:

the CertificateReference object itself.

withVisibility

public CertificateReference withVisibility(List 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.