Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzFederatedIdentityCredential

Gets the federated identity credential.

Syntax

List (Default) 

Get-AzFederatedIdentityCredential
 -IdentityName <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String[]>]
 [-Skiptoken <String>]
 [-Top <Int32>]
 [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get 

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

GetViaIdentity 

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

Description

Gets the federated identity credential.

Examples

Example 1: List federated identity credentials under a user assigned identity

Get-AzFederatedIdentityCredential -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01

Name Issuer Subject Audience
---- ------ ------- --------
fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange}
fic-pwsh02 https://kubernetes-oauth-2.azure.com system:serviceaccount-2:ns:svcaccount {api://AzureADTokenExchange}

This command lists federated identity credentials under a user assigned identity.

Example 2: Get a federated identity credential

Get-AzFederatedIdentityCredential -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 -Name fic-pwsh01

Name Issuer Subject Audience
---- ------ ------- --------
fic-pwsh01 https://kubernetes-oauth.azure.com system:serviceaccount:ns:svcaccount {api://AzureADTokenExchange}

This command gets a federated identity credential by name.

Example 3: Get a federated identity credential by pipeline

New-AzFederatedIdentityCredential -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 `
 -Name fic-pwsh03 -Issuer "https://kubernetes-oauth-3.azure.com" -Subject "system:serviceaccount-3:ns:svcaccount" `
 | Get-AzFederatedIdentityCredential

Name Issuer Subject Audience
---- ------ ------- --------
fic-pwsh03 https://kubernetes-oauth-3.azure.com system:serviceaccount-3:ns:svcaccount {api://AzureADTokenExchange}

This command creates and gets a federated identity credential 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

-IdentityName

The name of the identity resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Type:IManagedServiceIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

The name of the federated identity credential resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Skiptoken

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-Top

Number of records to return.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

IManagedServiceIdentity

Outputs

IFederatedIdentityCredential

Notes

ALIASES

Get-AzFederatedIdentityCredentials

Feedback

Was this page helpful?