Share via

ApiManagementServiceIdentity interface

  • Reference
Package:
@azure/arm-apimanagement

Identity properties of the Api Management service resource.

Properties

principalId

The principal id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId

The client tenant id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities

The list of user identities associated with the resource. 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 identity. NOTE: This property will not be serialized. It can only be populated by the server.

principalId?: string

Property Value

string

tenantId

The client tenant id of the 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 identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

type: string

Property Value

string

userAssignedIdentities

The list of user identities associated with the resource. 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]: UserIdentityProperties}

Property Value

{[propertyName: string]: UserIdentityProperties}