< Back

Get-AzureRmApiManagementIdentityProvider

Tue Jan 29, 2019 9:29 pm

NAME Get-AzureRmApiManagementIdentityProvider



SYNOPSIS

Get the identity provider configuration details.





SYNTAX

Get-AzureRmApiManagementIdentityProvider -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -Type {Facebook | Google |

Microsoft | Twitter | Aad} [<CommonParameters>]





DESCRIPTION

Get the identity provider configuration details.





PARAMETERS

-Context <PsApiManagementContext>

Instance of PsApiManagementContext. This parameter is required.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Type <PsApiManagementIdentityProviderType>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider

The details of the Identity Provider configured in API Management service.



IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider>

The list of Identity Providers configured in API Management service.





NOTES









Example 1: Get all Identity Providers



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext



Get all the identity provider Configuration on the service.





Get the AAD Type Identity Provider



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Aad



Gets the Identity Provider Configuration of Azure Active Directory.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... typrovider