Servicio Microsoft.ApiManagement/openidConnectProviders 2023-03-01-preview
Definición de recursos de Bicep
El tipo de recurso service/openidConnectProviders se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo 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 bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview' = {
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 | 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 de 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 de desarrollador que es la aplicación cliente. | string |
description | Descripción fácil de usar del proveedor de OpenID Connect. | string |
DisplayName | Nombre del proveedor de OpenID Connect descriptivo. | string (obligatorio) |
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 en el 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 |
---|---|
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
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:
- Grupos de recursos: consulte los comandos de implementación del grupo 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 json a la plantilla.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-03-01-preview",
"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 | Value |
---|---|---|
type | Tipo de recurso | 'Microsoft.ApiManagement/service/openidConnectProviders' |
apiVersion | La versión de la API de recursos | "2023-03-01-preview" |
name | 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 una letra y termine con un carácter alfanumérico. |
properties | Propiedades del contrato del proveedor de 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 de desarrollador que es la aplicación cliente. | string |
description | Descripción fácil de usar del proveedor de OpenID Connect. | string |
DisplayName | Nombre del proveedor de OpenID Connect descriptivo. | string (obligatorio) |
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 en el 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 |
---|---|
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla |
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
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@2023-03-01-preview"
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 | Value |
---|---|---|
type | Tipo de recurso | "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview" |
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 de 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 de desarrollador que es la aplicación cliente. | string |
description | Descripción fácil de usar del proveedor de OpenID Connect. | string |
DisplayName | Nombre del proveedor de OpenID Connect descriptivo. | string (obligatorio) |
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 en el 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 |