Get-AzUserAssignedIdentity
Gets the identity.
Syntax
List (Default)
Get-AzUserAssignedIdentity
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzUserAssignedIdentity
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List1
Get-AzUserAssignedIdentity
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter
Parameter properties
| Type: | IManagedServiceIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of the identity resource.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the Resource Group to which the identity belongs.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The Id of the Subscription to which the identity belongs.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
List
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
List1
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
