Get-AzApiManagementIdentityProvider
Get the identity provider configuration details.
Syntax
AllIdentityProviders (Default)
Get-AzApiManagementIdentityProvider
-Context <PsApiManagementContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
IdentityProviderByType
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.
Parameter properties
| Type: | PsApiManagementContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, 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 |
-Type
Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional.
Parameter properties
| Type: | PsApiManagementIdentityProviderType |
| Default value: | None |
| Accepted values: | Facebook, Google, Microsoft, Twitter, Aad, AadB2C |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentityProviderByType
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
