Serviço Microsoft.ApiManagement/openidConnectProviders
Definição de recurso do Bicep
O tipo de recurso service/openidConnectProviders pode ser implantado em:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o seguinte Bicep ao modelo.
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 propriedade
service/openidConnectProviders
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos e hifens. Comece com uma letra e termine com um caractere alfanumérico. |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte Recurso filho fora do recurso pai. |
Nome simbólico para o recurso do tipo: serviço |
| properties | Propriedades do contrato do Provedor do OpenId Connect. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientId | ID do cliente do console do desenvolvedor, que é o aplicativo cliente. | cadeia de caracteres (obrigatório) |
| clientSecret | Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. | string |
| descrição | Descrição amigável do Provedor do OpenID Connect. | string |
| displayName | Nome do provedor do OpenID Connect amigável. | cadeia de caracteres (obrigatório) |
| metadataEndpoint | URI do ponto de extremidade de metadados. | cadeia de caracteres (obrigatório) |
| useInApiDocumentation | Se for true, o provedor Open ID Connect será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido. | bool |
| useInTestConsole | Se for true, o provedor Open ID Connect poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. | bool |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo |
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub-entidades |
Definição de recurso de modelo do ARM
O tipo de recurso service/openidConnectProviders pode ser implantado em:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o JSON a seguir ao modelo.
{
"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 propriedade
service/openidConnectProviders
| Nome | Descrição | Valor |
|---|---|---|
| type | O tipo de recurso | 'Microsoft.ApiManagement/service/openidConnectProviders' |
| apiVersion | A versão da API de recursos | '2022-08-01' |
| name | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON. |
cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos e hifens. Comece com uma letra e termine com um caractere alfanumérico. |
| properties | Propriedades do contrato do Provedor do OpenId Connect. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientId | ID do cliente do console do desenvolvedor, que é o aplicativo cliente. | cadeia de caracteres (obrigatório) |
| clientSecret | Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. | string |
| descrição | Descrição amigável do Provedor do OpenID Connect. | string |
| displayName | Nome do provedor do OpenID Connect amigável. | cadeia de caracteres (obrigatório) |
| metadataEndpoint | URI do ponto de extremidade de metadados. | cadeia de caracteres (obrigatório) |
| useInApiDocumentation | Se for true, o provedor Open ID Connect será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido. | bool |
| useInTestConsole | Se for true, o provedor Open ID Connect poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. | bool |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
| Modelo | Descrição |
|---|---|
| Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo |
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso service/openidConnectProviders pode ser implantado em:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o Terraform a seguir ao modelo.
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 propriedade
service/openidConnectProviders
| Nome | Descrição | Valor |
|---|---|---|
| type | O tipo de recurso | "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Caracteres alfanuméricos e hifens. Comece com uma letra e termine com um caractere alfanumérico. |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: serviço |
| properties | Propriedades do contrato do Provedor do OpenId Connect. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nome | Descrição | Valor |
|---|---|---|
| clientId | ID do cliente do console do desenvolvedor, que é o aplicativo cliente. | cadeia de caracteres (obrigatório) |
| clientSecret | Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. | string |
| descrição | Descrição amigável do Provedor do OpenID Connect. | string |
| displayName | Nome do provedor do OpenID Connect amigável. | cadeia de caracteres (obrigatório) |
| metadataEndpoint | URI do ponto de extremidade de metadados. | cadeia de caracteres (obrigatório) |
| useInApiDocumentation | Se for true, o provedor Open ID Connect será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido. | bool |
| useInTestConsole | Se for true, o provedor Open ID Connect poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. | bool |