Package com.azure.resourcemanager.compute.models

Class VirtualMachineEncryptionConfiguration<T extends VirtualMachineEncryptionConfiguration<T>>

java.lang.Object

com.azure.resourcemanager.compute.models.VirtualMachineEncryptionConfiguration<T>

Type Parameters:

T - type presenting Windows or Linux specific settings

Direct Known Subclasses:

LinuxVMDiskEncryptionConfiguration, WindowsVMDiskEncryptionConfiguration

public abstract class VirtualMachineEncryptionConfiguration<T extends VirtualMachineEncryptionConfiguration<T>>
extends Object

Type representing encryption configuration to be applied to a virtual machine.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	aadClientId	The AAD client ID.
protected String	aadSecret	The AAD secret.
protected com.azure.core.management.AzureEnvironment	azureEnvironment	The AzureEnvironment.
protected String	encryptionAlgorithm	The encryption algorithm.
protected String	keyEncryptionKeyUrl	The key encryption key URL.
protected String	keyEncryptionKeyVaultId	The key encryption key KeyVault ID.
protected String	keyVaultId	The KeyVault ID.
protected String	passPhrase	The pass phrase.
protected String	vaultUri	The KeyVault URI.
protected DiskVolumeType	volumeType	The volume type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VirtualMachineEncryptionConfiguration(String keyVaultId, String vaultUri, com.azure.core.management.AzureEnvironment azureEnvironment)	Creates VirtualMachineEncryptionConfiguration.
protected	VirtualMachineEncryptionConfiguration(String keyVaultId, String vaultUri, String aadClientId, String aadSecret, com.azure.core.management.AzureEnvironment azureEnvironment)	Creates VirtualMachineEncryptionConfiguration.

Method Summary

Modifier and Type	Method	Description
String	aadClientId()
String	aadSecret()
String	keyEncryptionKeyUrl()
String	keyEncryptionKeyVaultId()
String	keyVaultId()
String	keyVaultUrl()
String	linuxPassPhrase()
abstract OperatingSystemTypes	osType()
String	volumeEncryptionKeyEncryptAlgorithm()
DiskVolumeType	volumeType()
T	withVolumeEncryptionKeyEncryptAlgorithm(String encryptionAlgorithm)	Specifies the algorithm used to encrypt the disk-encryption key.
T	withVolumeEncryptionKeyEncrypted(String keyEncryptionKeyUrl)	Specifies the Key Vault URL to the key for protecting or wrapping the disk-encryption key.
T	withVolumeEncryptionKeyEncrypted(String keyEncryptionKeyUrl, String keyEncryptionKeyKevVaultId)	Specifies the and key vault Id and a vault URL to the key for protecting or wrapping the disk-encryption key.
T	withVolumeType(DiskVolumeType volumeType)	Specifies the volume to encrypt.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keyVaultId

protected final String keyVaultId

The KeyVault ID.

aadClientId

protected final String aadClientId

The AAD client ID.

aadSecret

protected final String aadSecret

The AAD secret.

volumeType

protected DiskVolumeType volumeType

The volume type.

keyEncryptionKeyUrl

protected String keyEncryptionKeyUrl

The key encryption key URL.

keyEncryptionKeyVaultId

protected String keyEncryptionKeyVaultId

The key encryption key KeyVault ID.

encryptionAlgorithm

protected String encryptionAlgorithm

The encryption algorithm.

passPhrase

protected String passPhrase

The pass phrase.

azureEnvironment

protected final com.azure.core.management.AzureEnvironment azureEnvironment

The AzureEnvironment.

vaultUri

protected final String vaultUri

The KeyVault URI.

Constructor Detail

VirtualMachineEncryptionConfiguration

protected VirtualMachineEncryptionConfiguration(String keyVaultId,
                                                String vaultUri,
                                                String aadClientId,
                                                String aadSecret,
                                                com.azure.core.management.AzureEnvironment azureEnvironment)

Creates VirtualMachineEncryptionConfiguration.

Parameters:

keyVaultId - resource ID of the KeyVault to store the disk encryption key

vaultUri - URI of the key vault data-plane endpoint

aadClientId - AAD application client ID to access the KeyVault

aadSecret - AAD application client secret to access the KeyVault

azureEnvironment - Azure environment

VirtualMachineEncryptionConfiguration

protected VirtualMachineEncryptionConfiguration(String keyVaultId,
                                                String vaultUri,
                                                com.azure.core.management.AzureEnvironment azureEnvironment)

Creates VirtualMachineEncryptionConfiguration.

Parameters:

keyVaultId - resource ID of the KeyVault to store the disk encryption key

vaultUri - URI of the key vault data-plane endpoint

azureEnvironment - Azure environment

Method Detail

osType

public abstract OperatingSystemTypes osType()

Returns:

the operating system type

aadClientId

public String aadClientId()

Returns:

the AAD application client ID to access the key vault

aadSecret

public String aadSecret()

Returns:

the AAD application client secret to access the key vault

volumeType

public DiskVolumeType volumeType()

Returns:

type of the volume to perform encryption operation

keyVaultId

public String keyVaultId()

Returns:

resource ID of the key vault to store the disk encryption key

keyVaultUrl

public String keyVaultUrl()

Returns:

URL to the key vault to store the disk encryption key

keyEncryptionKeyVaultId

public String keyEncryptionKeyVaultId()

Returns:

resource ID of the Key Vault holding key encryption key (KEK)

keyEncryptionKeyUrl

public String keyEncryptionKeyUrl()

Returns:

key vault URL to the key (KEK) to protect (encrypt) the disk-encryption key

volumeEncryptionKeyEncryptAlgorithm

public String volumeEncryptionKeyEncryptAlgorithm()

Returns:

the algorithm used to encrypt the disk-encryption key

linuxPassPhrase

public String linuxPassPhrase()

Returns:

the pass phrase to encrypt Linux OS and data disks

withVolumeType

public T withVolumeType(DiskVolumeType volumeType)

Specifies the volume to encrypt.

Parameters:

volumeType - the volume type

Returns:

VirtualMachineEncryptionConfiguration

withVolumeEncryptionKeyEncrypted

public T withVolumeEncryptionKeyEncrypted(String keyEncryptionKeyUrl)

Specifies the Key Vault URL to the key for protecting or wrapping the disk-encryption key.

Parameters:

keyEncryptionKeyUrl - the key (KEK) URL

Returns:

VirtualMachineEncryptionConfiguration

withVolumeEncryptionKeyEncrypted

public T withVolumeEncryptionKeyEncrypted(String keyEncryptionKeyUrl,
                                          String keyEncryptionKeyKevVaultId)

Specifies the and key vault Id and a vault URL to the key for protecting or wrapping the disk-encryption key.

Parameters:

keyEncryptionKeyUrl - the key (KEK) URL

keyEncryptionKeyKevVaultId - resource ID of the keyVault storing KEK

Returns:

VirtualMachineEncryptionConfiguration

withVolumeEncryptionKeyEncryptAlgorithm

public T withVolumeEncryptionKeyEncryptAlgorithm(String encryptionAlgorithm)

Specifies the algorithm used to encrypt the disk-encryption key.

Parameters:

encryptionAlgorithm - the algorithm

Returns:

VirtualMachineEncryptionConfiguration