Compartir a través de

Servicio Microsoft.ApiManagement/openidConnectProviders 2022-08-01

  • Artículo

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 recurso

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

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

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Valor
nombre 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 la letra y termine con alfanumérico.
padre 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 obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: de servicio de
Propiedades Propiedades del contrato del proveedor openId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Id. 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. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
descripción Descripción fácil de usar del proveedor openID Connect. cuerda
displayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)

Restricciones:
Longitud máxima = 50
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)
useInApiDocumentation Si es true, el proveedor open ID Connect se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. Bool
useInTestConsole Si es true, el proveedor open ID Connect se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. Bool

Plantillas de inicio rápido

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

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

Implementación en Azure 		Esta plantilla 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 recurso

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

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

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Valor
tipo El tipo de recurso 'Microsoft.ApiManagement/service/openidConnectProviders'
apiVersion La versión de la API de recursos '2022-08-01'
nombre El nombre del recurso

Vea 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 la letra y termine con alfanumérico.
Propiedades Propiedades del contrato del proveedor openId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Id. 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. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
descripción Descripción fácil de usar del proveedor openID Connect. cuerda
displayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)

Restricciones:
Longitud máxima = 50
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)
useInApiDocumentation Si es true, el proveedor open ID Connect se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. Bool
useInTestConsole Si es true, el proveedor open ID Connect se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. Bool

Plantillas de inicio rápido

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

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

Implementación en Azure 		Esta plantilla 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 de

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

Formato de recurso

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

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

Valores de propiedad

service/openidConnectProviders

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01"
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

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

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

OpenidConnectProviderContractProperties

Nombre Descripción Valor
clientId Id. 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. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
descripción Descripción fácil de usar del proveedor openID Connect. cuerda
displayName Nombre del proveedor de OpenID Connect descriptivo. string (obligatorio)

Restricciones:
Longitud máxima = 50
metadataEndpoint URI del punto de conexión de metadatos. string (obligatorio)
useInApiDocumentation Si es true, el proveedor open ID Connect se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. Bool
useInTestConsole Si es true, el proveedor open ID Connect se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. Bool