The service/openidConnectProviders resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.ApiManagement/service/openidConnectProviders' |
apiVersion | The resource api version | '2023-05-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
properties | OpenId Connect Provider contract properties. | OpenidConnectProviderContractProperties |
Name | Description | Value |
---|---|---|
clientId | Client ID of developer console which is the client application. | string (required) |
clientSecret | Client Secret of developer console which is the client application. | string |
description | User-friendly description of OpenID Connect Provider. | string |
displayName | User-friendly OpenID Connect Provider name. | string (required) |
metadataEndpoint | Metadata endpoint URI. | string (required) |
useInApiDocumentation | If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. | bool |
useInTestConsole | If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. | bool |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |