CertificateReference Class

Package:

com.microsoft.azure.management.batch

Maven Artifact:

com.microsoft.azure:azure-mgmt-batch:1.41.4

• java.lang.Object
• • com.microsoft.azure.management.batch.CertificateReference

public class CertificateReference

A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.

Constructor Summary

Constructor	Description
CertificateReference()

Method Summary

Modifier and Type	Method and Description
java.lang.String	id() Get the id value.
CertificateStoreLocation	storeLocation() Get the default value is currentUser.
java.lang.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).
java.util.List<CertificateVisibility>	visibility() Get the visibility value.
CertificateReference	withId(String id) Set the id value.
CertificateReference	withStoreLocation(CertificateStoreLocation storeLocation) Set the default value is currentUser.
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).
CertificateReference	withVisibility(List<CertificateVisibility> visibility) Set the visibility value.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

CertificateReference

public CertificateReference()

Method Details

id

public String id()

Get the id value.

Returns:

the id value

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

visibility

public List visibility()

Get the visibility value.

Returns:

the visibility value

withId

public CertificateReference withId(String id)

Set the id value.

Parameters:

id - the id value to set

Returns:

the CertificateReference object itself.

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.

withVisibility

public CertificateReference withVisibility(List visibility)

Set the visibility value.

Parameters:

visibility - the visibility value to set

Returns:

the CertificateReference object itself.