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 | _models.JsonWebKeyEncryptionAlgorithm | None = None, msi_resource_id: str | None = None, encryption_at_host: bool = False, **kwargs: Any)

Keyword-Only Parameters

Name Description
vault_uri
str

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

Default value: None
key_name
str

Key name that is used for enabling disk encryption.

Default value: None
key_version
str

Specific key version that is used for enabling disk encryption.

Default value: None
encryption_algorithm

Algorithm identifier for encryption, default RSA-OAEP. Known values are: "RSA-OAEP", "RSA-OAEP-256", and "RSA1_5".

Default value: None
msi_resource_id
str

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

Default value: None
encryption_at_host

Indicates whether or not resource disk encryption is enabled.

Default value: False

Variables

Name Description
vault_uri
str

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

key_name
str

Key name that is used for enabling disk encryption.

key_version
str

Specific key version that is used for enabling disk encryption.

encryption_algorithm

Algorithm identifier for encryption, default RSA-OAEP. Known values are: "RSA-OAEP", "RSA-OAEP-256", and "RSA1_5".

msi_resource_id
str

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

encryption_at_host

Indicates whether or not resource disk encryption is enabled.