Get-AzFederatedIdentityCredentials

Reference

Module:: Az.ManagedServiceIdentity

Gets the federated identity credential.

Syntax

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

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

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

Description

Gets the federated identity credential.

Examples

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

Get-AzFederatedIdentityCredentials -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-AzFederatedIdentityCredentials -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-AzFederatedIdentityCredentials -ResourceGroupName azure-rg-test -IdentityName uai-pwsh01 `
    -Name fic-pwsh03 -Issuer "https://kubernetes-oauth-3.azure.com" -Subject "system:serviceaccount-3:ns:svcaccount" `
        | Get-AzFederatedIdentityCredentials

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 credentials, account, tenant, and subscription used for communication with Azure.

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

-IdentityName

The name of the identity resource.

Type:	String
Position:	Named
Default value:	None
Required:	True
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 federated identity credential 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. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	String
Position:	Named
Default value:	None
Required:	False
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

-Top

Number of records to return.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IManagedServiceIdentity

Outputs

IFederatedIdentityCredential

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

[FederatedIdentityCredentialResourceName <String>]: The name of the federated identity credential resource.
[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.