Get-AzApiManagementOpenIdConnectProvider

  • Reference
Module:
Az.ApiManagement

Gets OpenID Connect providers.

Syntax

Get-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   [-OpenIdConnectProviderId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzApiManagementOpenIdConnectProvider cmdlet gets OpenID Connect providers in Azure API Management. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementOpenIdConnectProviderClientSecret.

Examples

Example 1: Get all providers

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

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

Example 2: Get a provider by using an ID

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01"

This command gets the provider that has the ID OICProvider01.

Example 3: Get a provider by using a name

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider"

This command gets the provider named Contoso OpenID Connect Provider.

Parameters

-Context

Specifies a PsApiManagementContext object.

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

-Name

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

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

-OpenIdConnectProviderId

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

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

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementOpenIdConnectProvider