Partilhar via

Serviço Microsoft.ApiManagement/openidConnectProviders 2022-08-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/openidConnectProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.ApiManagement/service/openidConnectProviders

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
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 recurso do tipo: serviço
propriedades Propriedades do contrato do OpenId Connect Provider. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Designação Descrição Valor
ID do cliente ID do cliente do console do desenvolvedor, que é o aplicativo cliente. string (obrigatório)
clientSecret Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Descrição Descrição amigável do OpenID Connect Provider. string
displayName Nome do provedor OpenID Connect de fácil utilização. string

Restrições:
Comprimento máximo = 50 (obrigatório)
metadataEndpoint URI do ponto de extremidade de metadados. string (obrigatório)
useInApiDocumentation Se verdadeiro, 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 verdadeiro, o provedor Open ID Connect pode ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. Bool

Definição de recurso de modelo ARM

O tipo de recurso service/openidConnectProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o seguinte JSON ao seu 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

Microsoft.ApiManagement/service/openidConnectProviders

Designação Descrição Valor
apiVersion A versão api '2022-08-01'
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades do contrato do OpenId Connect Provider. OpenidConnectProviderContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/openidConnectProviders'

OpenidConnectProviderContractProperties

Designação Descrição Valor
ID do cliente ID do cliente do console do desenvolvedor, que é o aplicativo cliente. string (obrigatório)
clientSecret Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Descrição Descrição amigável do OpenID Connect Provider. string
displayName Nome do provedor OpenID Connect de fácil utilização. string

Restrições:
Comprimento máximo = 50 (obrigatório)
metadataEndpoint URI do ponto de extremidade de metadados. string (obrigatório)
useInApiDocumentation Se verdadeiro, 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 verdadeiro, o provedor Open ID Connect pode ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. Bool

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/openidConnectProviders pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/openidConnectProviders, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.ApiManagement/service/openidConnectProviders

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Propriedades do contrato do OpenId Connect Provider. OpenidConnectProviderContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/openidConnectProviders@2022-08-01"

OpenidConnectProviderContractProperties

Designação Descrição Valor
ID do cliente ID do cliente do console do desenvolvedor, que é o aplicativo cliente. string (obrigatório)
clientSecret Segredo do cliente do console do desenvolvedor, que é o aplicativo cliente. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Descrição Descrição amigável do OpenID Connect Provider. string
displayName Nome do provedor OpenID Connect de fácil utilização. string

Restrições:
Comprimento máximo = 50 (obrigatório)
metadataEndpoint URI do ponto de extremidade de metadados. string (obrigatório)
useInApiDocumentation Se verdadeiro, 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 verdadeiro, o provedor Open ID Connect pode ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido. Bool