Share via

DiskEncryptionSet Class

  • Reference

disk encryption set resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.compute.v2023_04_02.models._models_py3.Resource
DiskEncryptionSet

Constructor

DiskEncryptionSet(*, location: str, tags: Dict[str, str] | None = None, identity: _models.EncryptionSetIdentity | None = None, encryption_type: str | _models.DiskEncryptionSetType | None = None, active_key: _models.KeyForDiskEncryptionSet | None = None, rotation_to_latest_key_version_enabled: bool | None = None, federated_client_id: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
identity
EncryptionSetIdentity

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type
str or DiskEncryptionSetType

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

The key vault key which is currently used by this disk encryption set.
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.
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.

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
identity
EncryptionSetIdentity

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
encryption_type
str or DiskEncryptionSetType

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

The key vault key which is currently used by this disk encryption set.
previous_keys
list[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
datetime

The time when the active key of this disk encryption set was updated.
auto_key_rotation_error
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.