Share via

SystemAssignedIdentity interface

  • Reference
Package:
@azure/arm-msi

Describes a system assigned identity resource.

Extends
ProxyResource

Properties

clientId

The id of the app associated with the identity. This is a random generated UUID by MSI. NOTE: This property will not be serialized. It can only be populated by the server.
clientSecretUrl

The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
principalId

The id of the service principal object associated with the created identity. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
tenantId

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

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

clientId

The id of the app associated with the identity. This is a random generated UUID by MSI. NOTE: This property will not be serialized. It can only be populated by the server.

clientId?: string

Property Value

string

clientSecretUrl

The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. NOTE: This property will not be serialized. It can only be populated by the server.

clientSecretUrl?: string

Property Value

string

location

The geo-location where the resource lives

location: string

Property Value

string

principalId

The id of the service principal object associated with the created identity. NOTE: This property will not be serialized. It can only be populated by the server.

principalId?: string

Property Value

string

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

tenantId

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

tenantId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type