Share via

VaultCertificate Class

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.compute.models.VaultCertificate

Implements

JsonSerializable<VaultCertificate>

public final class VaultCertificate
implements JsonSerializable<VaultCertificate>

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Constructor Summary

Constructor Description
VaultCertificate()

Creates an instance of VaultCertificate class.

Method Summary

Modifier and Type Method and Description
String certificateStore()

Get the certificateStore property: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added.
String certificateUrl()

Get the certificateUrl property: This is the URL of a certificate that has been uploaded to Key Vault as a secret.
static VaultCertificate fromJson(JsonReader jsonReader)

Reads an instance of VaultCertificate from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
VaultCertificate withCertificateStore(String certificateStore)

Set the certificateStore property: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added.
VaultCertificate withCertificateUrl(String certificateUrl)

Set the certificateUrl property: This is the URL of a certificate that has been uploaded to Key Vault as a secret.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VaultCertificate

public VaultCertificate()

Creates an instance of VaultCertificate class.

Method Details

certificateStore

public String certificateStore()

Get the certificateStore property: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted.

Returns:

the certificateStore value.

certificateUrl

public String certificateUrl()

Get the certificateUrl property: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/\#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).

Returns:

the certificateUrl value.

fromJson

public static VaultCertificate fromJson(JsonReader jsonReader)

Reads an instance of VaultCertificate from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VaultCertificate if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the VaultCertificate.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withCertificateStore

public VaultCertificate withCertificateStore(String certificateStore)

Set the certificateStore property: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted.

Parameters:

certificateStore - the certificateStore value to set.

Returns:

the VaultCertificate object itself.

withCertificateUrl

public VaultCertificate withCertificateUrl(String certificateUrl)

Set the certificateUrl property: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/\#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).

Parameters:

certificateUrl - the certificateUrl value to set.

Returns:

the VaultCertificate object itself.

Applies to