Share via

Microsoft.ApiManagement service/openidConnectProviders 2024-05-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@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Property values

Microsoft.ApiManagement/service/openidConnectProviders

Name Description Value
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
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

Constraints:
Sensitive value. Pass in as a secure parameter.
description User-friendly description of OpenID Connect Provider. string
displayName User-friendly OpenID Connect Provider name. string

Constraints:
Max length = (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

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": "2024-05-01",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Property values

Microsoft.ApiManagement/service/openidConnectProviders

Name Description Value
apiVersion The api version '2024-05-01'
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
properties OpenId Connect Provider contract properties. OpenidConnectProviderContractProperties
type The resource type 'Microsoft.ApiManagement/service/openidConnectProviders'

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

Constraints:
Sensitive value. Pass in as a secure parameter.
description User-friendly description of OpenID Connect Provider. string
displayName User-friendly OpenID Connect Provider name. string

Constraints:
Max length = (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

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@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Property values

Microsoft.ApiManagement/service/openidConnectProviders

Name Description Value
name The resource name string

Constraints:
Max length =
Pattern = ^[^*#&+:<>?]+$ (required)
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
type The resource type "Microsoft.ApiManagement/service/openidConnectProviders@2024-05-01"

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

Constraints:
Sensitive value. Pass in as a secure parameter.
description User-friendly description of OpenID Connect Provider. string
displayName User-friendly OpenID Connect Provider name. string

Constraints:
Max length = (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