Share via

Identity interface

Package:
@azure/arm-search

Details about the search service identity. A null value indicates that the search service has no identity assigned.

Properties

principalId

The principal ID of the system-assigned identity of the search service. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId

The tenant ID of the system-assigned identity of the search service. 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 identity created by the system and a set of user assigned identities. The type 'None' will remove all 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 system-assigned identity of the search service. 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 system-assigned identity of the search service. 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 identity created by the system and a set of user assigned identities. The type 'None' will remove all 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]: UserAssignedIdentity}

Property Value

{[propertyName: string]: UserAssignedIdentity}