Get-AzureRmApiManagementIdentityProvider
Get the identity provider configuration details.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmApiManagementIdentityProvider
-Context <PsApiManagementContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmApiManagementIdentityProvider
-Context <PsApiManagementContext>
-Type <PsApiManagementIdentityProviderType>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
Get the identity provider configuration details.
Examples
Example 1: Get all Identity Providers
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContextGet all the identity provider Configuration on the service.
Get the Microsoft Entra ID Type Identity Provider
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext -Type AadGets the Identity Provider Configuration of Microsoft Entra ID.
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: | 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
PsApiManagementIdentityProviderType