Compartir a través de


Servicio Microsoft.ApiManagement/openidConnectProviders 2021-08-01

Definición de recursos de Bicep

El tipo de recurso service/openidConnectProviders se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/openidConnectProviders, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.
string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: servicio
properties Propiedades del contrato del proveedor openId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Identificador de cliente de la consola de desarrollador que es la aplicación cliente. string (obligatorio)
clientSecret Secreto de cliente de la consola del desarrollador, que es la aplicación cliente. string
description Descripción fácil de usar del proveedor openID Connect. string
DisplayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla

Implementación en Azure
En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades.

Definición de recursos de plantilla de ARM

El tipo de recurso service/openidConnectProviders se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/openidConnectProviders, agregue el siguiente json a la plantilla.

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

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Value
type Tipo de recurso 'Microsoft.ApiManagement/service/openidConnectProviders'
apiVersion La versión de la API de recursos '2021-08-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.
string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
properties Propiedades del contrato del proveedor openId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Identificador de cliente de la consola de desarrollador que es la aplicación cliente. string (obligatorio)
clientSecret Secreto de cliente de la consola del desarrollador, que es la aplicación cliente. string
description Descripción fácil de usar del proveedor openID Connect. string
DisplayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla

Implementación en Azure
En esta plantilla se muestra cómo crear un servicio API Management y configurar subentidades.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/openidConnectProviders se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/openidConnectProviders, agregue el siguiente terraform a la plantilla.

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"
    }
  })
}

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servicio
properties Propiedades del contrato del proveedor openId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Identificador de cliente de la consola de desarrollador que es la aplicación cliente. string (obligatorio)
clientSecret Secreto de cliente de la consola del desarrollador, que es la aplicación cliente. string
description Descripción fácil de usar del proveedor openID Connect. string
DisplayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)