Share via

DiskEncryptionProperties Class

The disk encryption properties.

Constructor

DiskEncryptionProperties(*, vault_uri: str | None = None, key_name: str | None = None, key_version: str | None = None, encryption_algorithm: str | JsonWebKeyEncryptionAlgorithm | None = None, msi_resource_id: str | None = None, encryption_at_host: bool | None = False, **kwargs)

Parameters

Name Description
vault_uri
Required
str

Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net.
key_name
Required
str

Key name that is used for enabling disk encryption.
key_version
Required
str

Specific key version that is used for enabling disk encryption.
encryption_algorithm
Required
str or JsonWebKeyEncryptionAlgorithm

Algorithm identifier for encryption, default RSA-OAEP. Possible values include: "RSA-OAEP", "RSA-OAEP-256", "RSA1_5".
msi_resource_id
Required
str

Resource ID of Managed Identity that is used to access the key vault.
encryption_at_host
Required
bool

Indicates whether or not resource disk encryption is enabled.

Keyword-Only Parameters

Name Description
vault_uri
Default value: None
key_name
Default value: None
key_version
Default value: None
encryption_algorithm
Default value: None
msi_resource_id
Default value: None
encryption_at_host
Default value: False