Package version:

Interface DiskEncryptionSet

disk encryption set resource.

interface DiskEncryptionSet {
    activeKey?: KeyForDiskEncryptionSet;
    autoKeyRotationError?: ApiError;
    encryptionType?: string;
    federatedClientId?: string;
    id?: string;
    identity?: EncryptionSetIdentity;
    lastKeyRotationTimestamp?: any;
    location: string;
    name?: string;
    previousKeys?: KeyForDiskEncryptionSet[];
    provisioningState?: string;
    rotationToLatestKeyVersionEnabled?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
}

Hierarchy (view full)

Properties

activeKey? autoKeyRotationError? encryptionType? federatedClientId? id? identity? lastKeyRotationTimestamp? location name? previousKeys? provisioningState? rotationToLatestKeyVersionEnabled? tags? type?

Properties

OptionalactiveKey

activeKey?: KeyForDiskEncryptionSet

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

Optional ReadonlyautoKeyRotationError

autoKeyRotationError?: 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. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalencryptionType

encryptionType?: string

The type of key used to encrypt the data of the disk.

OptionalfederatedClientId

federatedClientId?: string

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

Optional Readonlyid

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optionalidentity

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.

Optional ReadonlylastKeyRotationTimestamp

lastKeyRotationTimestamp?: any

The time when the active key of this disk encryption set was updated. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource location

Optional Readonlyname

name?: string

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlypreviousKeys

previousKeys?: 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. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyprovisioningState

provisioningState?: string

The disk encryption set provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalrotationToLatestKeyVersionEnabled

rotationToLatestKeyVersionEnabled?: boolean

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

Optionaltags

tags?: {
    [propertyName: string]: string;
}

Resource tags

Optional Readonlytype

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility