ResourceIdentity interface

An identity that can be associated with a resource.

Properties

principalId

The principal id of the identity. This property will only be provided for a system-assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId

The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. NOTE: This property will not be serialized. It can only be populated by the server.

type

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.

userAssignedIdentities

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

Property Details

principalId

The principal id of the identity. This property will only be provided for a system-assigned 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 associated with the resource's identity. This property will only be provided for a system-assigned 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. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.

type?: string

Property Value

string

userAssignedIdentities

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

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

Property Value

{[propertyName: string]: UserIdentity}