Compartilhar via

Serviço Microsoft.ApiManagement/openidConnectProviders 2023-09-01-preview

  • Artigo

Definição de recurso do Bicep

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 de 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@2023-09-01-preview' = {
  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

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento máximo =
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 do recurso do tipo: de serviço
Propriedades 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. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
descrição Descrição amigável do Provedor do OpenID Connect. corda
displayName Nome do provedor openid connect amigável. corda

Restrições:
Comprimento máximo = (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

Definição de recurso de modelo do 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 de 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": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/openidConnectProviders

Nome Descrição Valor
apiVersion A versão da API '2023-09-01-preview'
nome O nome do recurso corda

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

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. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
descrição Descrição amigável do Provedor do OpenID Connect. corda
displayName Nome do provedor openid connect amigável. corda

Restrições:
Comprimento máximo = (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

Definição de recurso do Terraform (provedor de 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 de log de alterações.

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
  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

Nome Descrição Valor
nome O nome do recurso corda

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

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. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
descrição Descrição amigável do Provedor do OpenID Connect. corda
displayName Nome do provedor openid connect amigável. corda

Restrições:
Comprimento máximo = (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