EncryptionSetPropertiesOutput interface
Properties
| active |
The key vault key which is currently used by this disk encryption set. |
| auto |
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. |
| encryption |
The type of key used to encrypt the data of the disk. |
| federated |
Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. |
| last |
The time when the active key of this disk encryption set was updated. |
| previous |
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 |
The disk encryption set provisioning state. |
| rotation |
Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. |
Property Details
activeKey
The key vault key which is currently used by this disk encryption set.
activeKey?: KeyForDiskEncryptionSetOutput
Property Value
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?: ApiErrorOutput
Property Value
encryptionType
The type of key used to encrypt the data of the disk.
encryptionType?: "EncryptionAtRestWithCustomerKey" | "EncryptionAtRestWithPlatformAndCustomerKeys" | "ConfidentialVmEncryptedWithCustomerKey"
Property Value
"EncryptionAtRestWithCustomerKey" | "EncryptionAtRestWithPlatformAndCustomerKeys" | "ConfidentialVmEncryptedWithCustomerKey"
federatedClientId
Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.
federatedClientId?: string
Property Value
string
lastKeyRotationTimestamp
The time when the active key of this disk encryption set was updated.
lastKeyRotationTimestamp?: string
Property Value
string
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?: KeyForDiskEncryptionSetOutput[]
Property Value
provisioningState
The disk encryption set provisioning state.
provisioningState?: string
Property Value
string
rotationToLatestKeyVersionEnabled
Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
rotationToLatestKeyVersionEnabled?: boolean
Property Value
boolean