EncryptionSetProperties Class

EncryptionSetProperties.

Constructor

EncryptionSetProperties()

Variables

Name	Description
encryption_type	Union[str, <xref:"DiskEncryptionSetType">] The type of key used to encrypt the data of the disk. Known values are: "EncryptionAtRestWithCustomerKey", "EncryptionAtRestWithPlatformAndCustomerKeys", and "ConfidentialVmEncryptedWithCustomerKey".
active_key	<xref:<xref:"KeyForDiskEncryptionSet">> The key vault key which is currently used by this disk encryption set.
previous_keys	list[<xref:"KeyForDiskEncryptionSet">] A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
provisioning_state	str The disk encryption set provisioning state.
rotation_to_latest_key_version_enabled	bool Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
last_key_rotation_timestamp	str The time when the active key of this disk encryption set was updated.
auto_key_rotation_error	<xref:<xref:"ApiError">> The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
federated_client_id	str Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.

Attributes

activeKey

The key vault key which is currently used by this disk encryption set.

activeKey: KeyForDiskEncryptionSet

autoKeyRotationError

The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.

autoKeyRotationError: ApiError

encryptionType

The type of key used to encrypt the data of the disk. Known values are: "EncryptionAtRestWithCustomerKey", "EncryptionAtRestWithPlatformAndCustomerKeys", and "ConfidentialVmEncryptedWithCustomerKey".

encryptionType: str | DiskEncryptionSetType

federatedClientId

Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.

federatedClientId: str

lastKeyRotationTimestamp

The time when the active key of this disk encryption set was updated.

lastKeyRotationTimestamp: str

previousKeys

A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.

previousKeys: list['KeyForDiskEncryptionSet']

provisioningState

The disk encryption set provisioning state.

provisioningState: str

rotationToLatestKeyVersionEnabled

Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.

rotationToLatestKeyVersionEnabled: bool