Edit

Get-AzUserAssignedIdentity

  • Reference
Module:
Az.ManagedServiceIdentity

Gets the identity.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzUserAssignedIdentity
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzUserAssignedIdentity
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzUserAssignedIdentity
   -InputObject <IManagedServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzUserAssignedIdentity
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the identity.

Examples

Example 1: Lists user assigned identity under a subscription

PS C:\>  Get-AzUserAssignedIdentity

Location      Name                                ResourceGroupName
--------      ----                                -----------------
eastus        AzSecPackAutoConfigUA-eastus        AzSecPackAutoConfigRG
eastus        uai-pwsh01                          azure-rg-test
eastus2       AzSecPackAutoConfigUA-eastus2       AzSecPackAutoConfigRG

This command lists user assigned identity under a subscription.

Example 2: List user assigned identity under a resource group

PS C:\> Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test

Location Name       ResourceGroupName
-------- ----       -----------------
eastus   uai-pwsh01 azure-rg-test

This command lists user assigned identity under a resource group.

Example 3: Get an user assigned identity

PS C:\> Get-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01

Location Name       ResourceGroupName
-------- ----       -----------------
eastus   uai-pwsh01 azure-rg-test

This command gets an user assigned identity.

Example 4: Get an user assigned identity by pipeline

PS C:\> New-AzUserAssignedIdentity -ResourceGroupName azure-rg-test -Name uai-pwsh01 -Location eastus
 | Get-AzUserAssignedIdentity

Location Name       ResourceGroupName
-------- ----       -----------------
eastus   uai-pwsh01 azure-rg-test

This command gets an user assigned identity by pipeline.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IManagedServiceIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

The name of the identity resource.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The name of the Resource Group to which the identity belongs.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

The Id of the Subscription to which the identity belongs.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IManagedServiceIdentity

Outputs

IIdentity

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IManagedServiceIdentity>: Identity Parameter

  • [Id <String>]: Resource identity path
  • [ResourceGroupName <String>]: The name of the Resource Group to which the identity belongs.
  • [ResourceName <String>]: The name of the identity resource.
  • [Scope <String>]: The resource provider scope of the resource. Parent resource being extended by Managed Identities.
  • [SubscriptionId <String>]: The Id of the Subscription to which the identity belongs.