Get-AzUserAssignedIdentity

Reference

Module:: Az.ManagedServiceIdentity

Gets the identity.

Syntax

Get-AzUserAssignedIdentity
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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

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

Get-AzUserAssignedIdentity
   -InputObject <IManagedServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the identity.

Examples

Example 1: Lists user assigned identity under a subscription

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

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

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

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 DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
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
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the identity resource.

Type:	String
Position:	Named
Default value:	None
Required:	True
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
Required:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IManagedServiceIdentity

Outputs

IIdentity