VirtualMachineEncryptionConfiguration<T> Class

Package:

com.microsoft.azure.management.compute

• java.lang.Object
• • com.microsoft.azure.management.compute.VirtualMachineEncryptionConfiguration<T>

Type Parameters

T

type presenting Windows or Linux specific settings

public class VirtualMachineEncryptionConfiguration<T extends VirtualMachineEncryptionConfiguration>

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

Field Summary

Modifier and Type	Field and Description
final String	aadClientId
final String	aadSecret
String	encryptionAlgorithm
String	keyEncryptionKeyURL
String	keyEncryptionKeyVaultId
final String	keyVaultId
String	passPhrase
DiskVolumeType	volumeType

Constructor Summary

Constructor	Description
VirtualMachineEncryptionConfiguration(String keyVaultId, String aadClientId, String aadSecret)	Creates VirtualMachineEncryptionConfiguration.

Method Summary

Modifier and Type	Method and 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.

Field Details

aadClientId

protected final String aadClientId

aadSecret

protected final String aadSecret

encryptionAlgorithm

protected String encryptionAlgorithm= "RSA-OAEP"

keyEncryptionKeyURL

protected String keyEncryptionKeyURL

keyEncryptionKeyVaultId

protected String keyEncryptionKeyVaultId

keyVaultId

protected final String keyVaultId

passPhrase

protected String passPhrase

volumeType

protected DiskVolumeType volumeType= DiskVolumeType.ALL

Constructor Details

VirtualMachineEncryptionConfiguration

protected VirtualMachineEncryptionConfiguration(String keyVaultId, String aadClientId, String aadSecret)

Creates VirtualMachineEncryptionConfiguration.

Parameters:

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

aadClientId - AAD application client ID to access the key vault

aadSecret - AAD application client secret to access the key vault

Method Details

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

keyEncryptionKeyURL

public String keyEncryptionKeyURL()

Returns:

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

keyEncryptionKeyVaultId

public String keyEncryptionKeyVaultId()

Returns:

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

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

linuxPassPhrase

public String linuxPassPhrase()

Returns:

the pass phrase to encrypt Linux OS and data disks

osType

public abstract OperatingSystemTypes osType()

Returns:

the operating system type

volumeEncryptionKeyEncryptAlgorithm

public String volumeEncryptionKeyEncryptAlgorithm()

Returns:

the algorithm used to encrypt the disk-encryption key

volumeType

public DiskVolumeType volumeType()

Returns:

type of the volume to perform encryption operation

withVolumeEncryptionKeyEncryptAlgorithm

public T withVolumeEncryptionKeyEncryptAlgorithm(String encryptionAlgorithm)

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

Parameters:

encryptionAlgorithm - the algorithm

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

withVolumeType

public T withVolumeType(DiskVolumeType volumeType)

Specifies the volume to encrypt.

Parameters:

volumeType - the volume type

Returns:

VirtualMachineEncryptionConfiguration