Compartilhar via

Microsoft.ApiManagement service/authorizationServers 2021-04-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso service/authorizationServers 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/authorizationServers, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
  }
}

Valores de propriedade

AuthorizationServerContractProperties

Nome Descrição Valor
authorizationEndpoint Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. cadeia de caracteres (obrigatório)
authorizationMethods Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional. Matriz de cadeia de caracteres que contém qualquer um dos:
'DELETE'
'GET'
'HEAD'
'OPÇÕES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica o mecanismo pelo qual o token de acesso é passado para a API. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
clientAuthenticationMethod Método de autenticação compatível com o ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. Matriz de cadeia de caracteres que contém qualquer um dos:
'Básico'
'Corpo'
clientId ID de cliente ou aplicativo registrada com este servidor de autorização. cadeia de caracteres (obrigatório)
clientRegistrationEndpoint Referência opcional a uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade que está sendo referenciada. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente ou aplicativo registrado com esse servidor de autorização. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
defaultScope Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço. corda
descrição Descrição do servidor de autorização. Pode conter marcas de formatação HTML. corda
displayName Nome do servidor de autorização amigável. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
grantTypes Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obrigatório)
resourceOwnerPassword Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Senha padrão do proprietário do recurso. corda
resourceOwnerUsername Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Nome de usuário do proprietário do recurso padrão. corda
supportState Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança do protocolo. Bool
tokenBodyParameters Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. TokenBodyParameterContract []
tokenEndpoint Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade que está sendo referenciada. corda

Microsoft.ApiManagement/service/authorizationServers

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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 servidor de autorização OAuth externo. AuthorizationServerContractProperties

TokenBodyParameterContract

Nome Descrição Valor
nome nome do parâmetro body. cadeia de caracteres (obrigatório)
valor valor do parâmetro body. cadeia de caracteres (obrigatório)

Definição de recurso de modelo do ARM

O tipo de recurso service/authorizationServers 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/authorizationServers, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string"
  }
}

Valores de propriedade

AuthorizationServerContractProperties

Nome Descrição Valor
authorizationEndpoint Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. cadeia de caracteres (obrigatório)
authorizationMethods Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional. Matriz de cadeia de caracteres que contém qualquer um dos:
'DELETE'
'GET'
'HEAD'
'OPÇÕES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica o mecanismo pelo qual o token de acesso é passado para a API. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
clientAuthenticationMethod Método de autenticação compatível com o ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. Matriz de cadeia de caracteres que contém qualquer um dos:
'Básico'
'Corpo'
clientId ID de cliente ou aplicativo registrada com este servidor de autorização. cadeia de caracteres (obrigatório)
clientRegistrationEndpoint Referência opcional a uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade que está sendo referenciada. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente ou aplicativo registrado com esse servidor de autorização. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
defaultScope Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço. corda
descrição Descrição do servidor de autorização. Pode conter marcas de formatação HTML. corda
displayName Nome do servidor de autorização amigável. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
grantTypes Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obrigatório)
resourceOwnerPassword Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Senha padrão do proprietário do recurso. corda
resourceOwnerUsername Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Nome de usuário do proprietário do recurso padrão. corda
supportState Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança do protocolo. Bool
tokenBodyParameters Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. TokenBodyParameterContract []
tokenEndpoint Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade que está sendo referenciada. corda

Microsoft.ApiManagement/service/authorizationServers

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
Propriedades Propriedades do contrato do servidor de autorização OAuth externo. AuthorizationServerContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/authorizationServers'

TokenBodyParameterContract

Nome Descrição Valor
nome nome do parâmetro body. cadeia de caracteres (obrigatório)
valor valor do parâmetro body. cadeia de caracteres (obrigatório)

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso service/authorizationServers 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/authorizationServers, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
    }
  })
}

Valores de propriedade

AuthorizationServerContractProperties

Nome Descrição Valor
authorizationEndpoint Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. cadeia de caracteres (obrigatório)
authorizationMethods Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional. Matriz de cadeia de caracteres que contém qualquer um dos:
'DELETE'
'GET'
'HEAD'
'OPÇÕES'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica o mecanismo pelo qual o token de acesso é passado para a API. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationHeader'
'consulta'
clientAuthenticationMethod Método de autenticação compatível com o ponto de extremidade de token deste servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded. Matriz de cadeia de caracteres que contém qualquer um dos:
'Básico'
'Corpo'
clientId ID de cliente ou aplicativo registrada com este servidor de autorização. cadeia de caracteres (obrigatório)
clientRegistrationEndpoint Referência opcional a uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade que está sendo referenciada. cadeia de caracteres (obrigatório)
clientSecret Segredo do cliente ou aplicativo registrado com esse servidor de autorização. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
defaultScope Escopo do token de acesso que será solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço. corda
descrição Descrição do servidor de autorização. Pode conter marcas de formatação HTML. corda
displayName Nome do servidor de autorização amigável. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
grantTypes Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso. Matriz de cadeia de caracteres que contém qualquer um dos:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obrigatório)
resourceOwnerPassword Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Senha padrão do proprietário do recurso. corda
resourceOwnerUsername Opcionalmente, pode ser especificado quando há suporte para o tipo de concessão de senha do proprietário do recurso por esse servidor de autorização. Nome de usuário do proprietário do recurso padrão. corda
supportState Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança do protocolo. Bool
tokenBodyParameters Parâmetros adicionais exigidos pelo ponto de extremidade de token deste servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}. TokenBodyParameterContract []
tokenEndpoint Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade que está sendo referenciada. corda

Microsoft.ApiManagement/service/authorizationServers

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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 servidor de autorização OAuth externo. AuthorizationServerContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview"

TokenBodyParameterContract

Nome Descrição Valor
nome nome do parâmetro body. cadeia de caracteres (obrigatório)
valor valor do parâmetro body. cadeia de caracteres (obrigatório)