< Back
New-AzureRmApiManagementOpenIdConnectProvider
Post
NAME New-AzureRmApiManagementOpenIdConnectProvider
SYNOPSIS
Creates an OpenID Connect provider.
SYNTAX
New-AzureRmApiManagementOpenIdConnectProvider -ClientId <String> [-ClientSecret <String>] -Context <PsApiManagementContext> [-DefaultProfile
<IAzureContextContainer>] [-Description <String>] -MetadataEndpointUri <String> -Name <String> [-OpenIdConnectProviderId <String>]
[<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementOpenIdConnectProvider cmdlet creates an OpenID Connect provider in Azure API Management.
PARAMETERS
-ClientId <String>
Specifies the client ID of the developer console.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClientSecret <String>
Specifies the client secret of the developer console.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-Description <String>
Specifies a description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MetadataEndpointUri <String>
Specifies a metadata endpoint URI of the provider.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies a friendly name for the provider.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OpenIdConnectProviderId <String>
Specifies an ID for the provider. If you do not specify an ID, this cmdlet generates one.
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
NOTES
Example 1: Create a provider
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -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
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ctprovider
Get-AzureRmApiManagementOpenIdConnectProvider
Remove-AzureRmApiManagementOpenIdConnectProvider
Set-AzureRmApiManagementOpenIdConnectProvider
SYNOPSIS
Creates an OpenID Connect provider.
SYNTAX
New-AzureRmApiManagementOpenIdConnectProvider -ClientId <String> [-ClientSecret <String>] -Context <PsApiManagementContext> [-DefaultProfile
<IAzureContextContainer>] [-Description <String>] -MetadataEndpointUri <String> -Name <String> [-OpenIdConnectProviderId <String>]
[<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementOpenIdConnectProvider cmdlet creates an OpenID Connect provider in Azure API Management.
PARAMETERS
-ClientId <String>
Specifies the client ID of the developer console.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClientSecret <String>
Specifies the client secret of the developer console.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-Description <String>
Specifies a description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MetadataEndpointUri <String>
Specifies a metadata endpoint URI of the provider.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies a friendly name for the provider.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OpenIdConnectProviderId <String>
Specifies an ID for the provider. If you do not specify an ID, this cmdlet generates one.
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
NOTES
Example 1: Create a provider
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -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
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ctprovider
Get-AzureRmApiManagementOpenIdConnectProvider
Remove-AzureRmApiManagementOpenIdConnectProvider
Set-AzureRmApiManagementOpenIdConnectProvider