New-AzApiManagementOpenIdConnectProvider

Creates an OpenID Connect provider.

Syntax

New-AzApiManagementOpenIdConnectProvider
   -Context <PsApiManagementContext>
   [-OpenIdConnectProviderId <String>]
   -Name <String>
   -MetadataEndpointUri <String>
   -ClientId <String>
   [-ClientSecret <String>]
   [-Description <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzApiManagementOpenIdConnectProvider cmdlet creates an OpenID Connect provider in Azure API Management.

Examples

Example 1: Create a provider

PS C:\>$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>New-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01" -Name "Contoso OpenID Connect Provider" -MetadataEndpointUri "https://openid.provider/configuration" -ClientId "12432143" -Description "OpenID Connect provider description"

This command creates an OpenID Connect Provider named Contoso OpenID Connect Provider

Example 2

Creates an OpenID Connect provider. (autogenerated)

 
New-AzApiManagementOpenIdConnectProvider -ClientId '12432143' -ClientSecret '000000000000000000000000000000000000000000' -Context  -Description 'OpenID Connect provider description' -MetadataEndpointUri 'https://openid.provider/configuration' -Name 'Contoso OpenID Connect Provider' -OpenIdConnectProviderId 'OICProvider01'

Parameters

-ClientId

Specifies the client ID of the developer console.

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

Specifies the client secret of the developer console.

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

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description.

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

Specifies a metadata endpoint URI of the provider.

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

Specifies a friendly name for the provider.

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

Specifies an ID for the provider. If you do not specify an ID, this cmdlet generates one.

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

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementOpenIdConnectProvider