Microsoft.ApiManagement service/openidConnectProviders 2021-08-01

  • Article

Bicep resource definition

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.

Resource format

To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
  }
}

Property values

service/openidConnectProviders

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service
properties OpenId Connect Provider contract properties. OpenidConnectProviderContractProperties

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure		 This template demonstrates how to create a API Management service and configure sub-entities

ARM template resource definition

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.

Resource format

To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string"
  }
}

Property values

service/openidConnectProviders

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/openidConnectProviders'
apiVersion The resource api version '2021-08-01'
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

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure		 This template demonstrates how to create a API Management service and configure sub-entities

Terraform (AzAPI provider) resource definition

The service/openidConnectProviders resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
    }
  })
}

Property values

service/openidConnectProviders

Name Description Value
type The resource type "Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties OpenId Connect Provider contract properties. OpenidConnectProviderContractProperties

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)