Microsoft.ApiManagement service/openidConnectProviders 2016-07-07

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2016-07-07' = {
  parent: resourceSymbolicName
  clientId: 'string'
  clientSecret: 'string'
  description: 'string'
  metadataEndpoint: 'string'
  name: 'string'
}

Property Values

Microsoft.ApiManagement/service/openidConnectProviders

Usage Examples

Bicep Samples

A basic example of deploying OpenID Connect Provider within a API Management Service.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The client ID for the OpenID Connect provider')
param openidClientId string
@secure()
@description('The client secret for the OpenID Connect provider')
param openidClientSecret string

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
  sku: {
    capacity: 0
    name: 'Consumption'
  }
}

resource openidConnectProvider 'Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01' = {
  parent: service
  name: resourceName
  properties: {
    clientId: null
    clientSecret: null
    description: ''
    displayName: 'Initial Name'
    metadataEndpoint: 'https://azacceptance.hashicorptest.com/example/foo'
  }
}

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2016-07-07",
  "name": "string",
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "metadataEndpoint": "string"
}

Property Values

Microsoft.ApiManagement/service/openidConnectProviders

Usage Examples

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@2016-07-07"
  name = "string"
  parent_id = "string"
  body = {
    clientId = "string"
    clientSecret = "string"
    description = "string"
    metadataEndpoint = "string"
  }
}

Property Values

Microsoft.ApiManagement/service/openidConnectProviders

Usage Examples

Terraform Samples

A basic example of deploying OpenID Connect Provider within a API Management Service.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "openid_client_id" {
  type        = string
  description = "The client ID for the OpenID Connect provider"
}

variable "openid_client_secret" {
  type        = string
  description = "The client secret for the OpenID Connect provider"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "openidConnectProvider" {
  type      = "Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      clientId         = var.openid_client_id
      clientSecret     = var.openid_client_secret
      description      = ""
      displayName      = "Initial Name"
      metadataEndpoint = "https://azacceptance.hashicorptest.com/example/foo"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}