Get-AzureRmApiManagementOpenIdConnectProvider

NAME Get-AzureRmApiManagementOpenIdConnectProvider



SYNOPSIS

Gets OpenID Connect providers.





SYNTAX

Get-AzureRmApiManagementOpenIdConnectProvider -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Name <String>]

[<CommonParameters>]



Get-AzureRmApiManagementOpenIdConnectProvider -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]

[-OpenIdConnectProviderId <String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmApiManagementOpenIdConnectProvider cmdlet gets OpenID Connect providers in Azure API Management.





PARAMETERS

-Context <PsApiManagementContext>

Specifies a PsApiManagementContext object.



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



-Name <String>

Specifies a friendly name of a provider. If you specify a name, this cmdlet gets that provider.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OpenIdConnectProviderId <String>

Specifies an ID of the provider that this cmdlet removes. If you specify an ID, this cmdlet gets that provider.



Required? false

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

The detail of the OpenId connect Provider configured in API Management service.



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

The list of OpenId Connect Providers configured in API Management service.





NOTES









Example 1: Get all providers



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

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



This command gets all OpenID Connect providers for the specified context.





Example 2: Get a provider by using an ID



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

PS C:\\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01"



This command gets the provider that has the ID OICProvicer01.





Example 3: Get a provider by using a name



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

PS C:\\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider"



This command gets the provider named Contoso OpenID Connect Provider.







RELATED LINKS

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

New-AzureRmApiManagementOpenIdConnectProvider

Remove-AzureRmApiManagementOpenIdConnectProvider

Set-AzureRmApiManagementOpenIdConnectProvider