BatchCertificateReference Class
- java.
lang. Object - com.
azure. compute. batch. models. BatchCertificateReference
- com.
Implements
public final class BatchCertificateReference
implements JsonSerializable<BatchCertificateReference>
A reference to a Certificate to be installed on Compute Nodes in a 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 Summary
| Constructor | Description |
|---|---|
| BatchCertificateReference(String thumbprint, String thumbprintAlgorithm) |
Creates an instance of Batch |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Batch |
fromJson(JsonReader jsonReader)
Reads an instance of Batch |
|
Batch |
getStoreLocation()
Get the store |
| String |
getStoreName()
Get the store |
| String |
getThumbprint()
Get the thumbprint property: The thumbprint of the Certificate. |
| String |
getThumbprintAlgorithm()
Get the thumbprint |
|
List<Batch |
getVisibility()
Get the visibility property: Which user Accounts on the Compute Node should have access to the private data of the Certificate. |
|
Batch |
setStoreLocation(BatchCertificateStoreLocation storeLocation)
Set the store |
|
Batch |
setStoreName(String storeName)
Set the store |
|
Batch |
setVisibility(List<BatchCertificateVisibility> visibility)
Set the visibility property: Which user Accounts on the Compute Node should have access to the private data of the Certificate. |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Constructor Details
BatchCertificateReference
public BatchCertificateReference(String thumbprint, String thumbprintAlgorithm)
Creates an instance of BatchCertificateReference class.
Parameters:
Method Details
fromJson
public static BatchCertificateReference fromJson(JsonReader jsonReader)
Reads an instance of BatchCertificateReference from the JsonReader.
Parameters:
Returns:
Throws:
getStoreLocation
public BatchCertificateStoreLocation getStoreLocation()
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 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.
Returns:
getStoreName
public String getStoreName()
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 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:
getThumbprint
public String getThumbprint()
Get the thumbprint property: The thumbprint of the Certificate.
Returns:
getThumbprintAlgorithm
public String getThumbprintAlgorithm()
Get the thumbprintAlgorithm property: The algorithm with which the thumbprint is associated. This must be sha1.
Returns:
getVisibility
public List<BatchCertificateVisibility> getVisibility()
Get the visibility property: Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more than one visibility in this collection. The default is all Accounts.
Returns:
setStoreLocation
public BatchCertificateReference setStoreLocation(BatchCertificateStoreLocation 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 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.
Parameters:
Returns:
setStoreName
public BatchCertificateReference setStoreName(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 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:
Returns:
setVisibility
public BatchCertificateReference setVisibility(List<BatchCertificateVisibility> visibility)
Set the visibility property: Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more than one visibility in this collection. The default is all Accounts.
Parameters:
Returns:
