EncryptionSetProperties Class

EncryptionSetProperties.

Constructor

EncryptionSetProperties(*args: Any, **kwargs: Any)

Variables

Name Description
encryption_type

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

active_key

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

previous_keys

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

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

last_key_rotation_timestamp

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

auto_key_rotation_error

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

active_key

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

active_key: _models.KeyForDiskEncryptionSet | None

auto_key_rotation_error

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.

auto_key_rotation_error: _models.ApiError | None

encryption_type

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

encryption_type: str | _models.DiskEncryptionSetType | None

federated_client_id

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

federated_client_id: str | None

last_key_rotation_timestamp

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

last_key_rotation_timestamp: datetime | None

previous_keys

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.

previous_keys: list['_models.KeyForDiskEncryptionSet'] | None

provisioning_state

The disk encryption set provisioning state.

provisioning_state: str | None

rotation_to_latest_key_version_enabled

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

rotation_to_latest_key_version_enabled: bool | None