Identity interface

Package:

@azure/arm-policy

Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity.

Properties

principalId	The principal ID of the resource 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 of the resource 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 identity type. This is the only required field when adding a system or user assigned identity to a resource.
userAssignedIdentities	The user identity associated with the policy. 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 principal ID of the resource 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 of the resource 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 identity type. This is the only required field when adding a system or user assigned identity to a resource.

type?: ResourceIdentityType

Property Value

ResourceIdentityType

userAssignedIdentities

The user identity associated with the policy. 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}