DiskEncryptionSet interface

Package:

@azure/arm-compute

disk encryption set resource.

Extends

Resource

Properties

activeKey	The key vault key which is currently used by this disk encryption set.
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. NOTE: This property will not be serialized. It can only be populated by the server.
encryptionType	The type of key used to encrypt the data of the disk.
federatedClientId	Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property.
identity	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.
lastKeyRotationTimestamp	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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The disk encryption set provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
rotationToLatestKeyVersionEnabled	Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.

Inherited Properties

id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

activeKey

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

activeKey?: KeyForDiskEncryptionSet

Property Value

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

autoKeyRotationError?: ApiError

Property Value

ApiError

encryptionType

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

encryptionType?: string

Property Value

string

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

identity

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.

identity?: EncryptionSetIdentity

Property Value

EncryptionSetIdentity

lastKeyRotationTimestamp

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.

lastKeyRotationTimestamp?: Date

Property Value

Date

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

previousKeys?: KeyForDiskEncryptionSet[]

Property Value

KeyForDiskEncryptionSet[]

provisioningState

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

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

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

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

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

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

type?: string

Property Value

string

Inherited From Resource.type