Share via

EncryptionSetIdentity interface

  • Reference
Package:
@azure/arm-compute

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.

Properties

principalId

The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity NOTE: This property will not be serialized. It can only be populated by the server.
tenantId

The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
userAssignedIdentities

The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Property Details

principalId

The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity NOTE: This property will not be serialized. It can only be populated by the server.

principalId?: string

Property Value

string

tenantId

The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

type

The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.

type?: string

Property Value

string

userAssignedIdentities

The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

userAssignedIdentities?: {[propertyName: string]: UserAssignedIdentitiesValue}

Property Value

{[propertyName: string]: UserAssignedIdentitiesValue}