Get-AzApiManagementIdentityProvider

Reference

Module:: Az.ApiManagement

Get the identity provider configuration details.

Syntax

Get-AzApiManagementIdentityProvider
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzApiManagementIdentityProvider
   -Context <PsApiManagementContext>
   -Type <PsApiManagementIdentityProviderType>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get the identity provider configuration details. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementIdentityProviderClientSecret.

Examples

Example 1: Get all Identity Providers

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementIdentityProvider -Context $apimContext

Get all the identity provider Configuration on the service.

Example 2: Get the AAD Type Identity Provider

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementIdentityProvider -Context $apimContext -Type Aad

Type                     : Aad
ClientId                 : aaa
ClientSecret             : xxxxx
AllowedTenants           : {contosotest.onmicrosoft.com}
Authority                : login.microsoftonline.com
SignupPolicyName         :
SigninPolicyName         :
ProfileEditingPolicyName :
PasswordResetPolicyName  :
SigninTenant             :
Id                       : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/identityProviders/Aad
ResourceGroupName        : Api-Default-West-US
ServiceName              : contoso

Gets the Identity Provider Configuration of Azure Active Directory.

Example 3: Get the AAD B2C Type Identity Provider

$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementIdentityProvider -Context $context -Type AadB2C

Type                     : AadB2C
ClientId                 : 00001111-aaaa-2222-bbbb-3333cccc4444
ClientSecret             : xxxxxx
AllowedTenants           : {contosoaadb2c.onmicrosoft.com}
Authority                : login.microsoftonline.com
SignupPolicyName         : B2C_1_policy-signup
SigninPolicyName         : B2C_1_policy-signin
ProfileEditingPolicyName :
PasswordResetPolicyName  :
SigninTenant             : contosoaadb2c.onmicrosoft.com
Id                       : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/identityProviders/AadB2C
ResourceGroupName        : Api-Default-West-US
ServiceName              : contoso

Gets the Identity Provider Configuration of Azure Active Directory.

Parameters

-Context

Instance of PsApiManagementContext. This parameter is required.

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Type

Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional.

Type:	PsApiManagementIdentityProviderType
Accepted values:	Facebook, Google, Microsoft, Twitter, Aad, AadB2C
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PsApiManagementContext

PsApiManagementIdentityProviderType

Outputs

PsApiManagementIdentityProvider

Share via