Compartilhar via

Serviço/apis Microsoft.ApiManagement 2016-07-07

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

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/apis, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Valores da propriedade

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Detalhes das configurações de Autenticação OAuth2 da API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrição Valor
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
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 do recurso do tipo: de serviço
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

Restrições:
Comprimento máximo = 400 (obrigatório)
Protocolos Descreve em quais protocolos as operações nesta API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
'Http'
'Https' (obrigatório)
serviceUrl URL absoluta do serviço de back-end que implementa essa API. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 2000 (obrigatório)
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

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/apis, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Valores da propriedade

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Detalhes das configurações de Autenticação OAuth2 da API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrição Valor
apiVersion A versão da API '2016-07-07'
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

Restrições:
Comprimento máximo = 400 (obrigatório)
Protocolos Descreve em quais protocolos as operações nesta API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
'Http'
'Https' (obrigatório)
serviceUrl URL absoluta do serviço de back-end que implementa essa API. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 2000 (obrigatório)
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda

Exemplos de uso

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

O tipo de recurso de serviço/apis pode ser implantado com operações de destino:

  • 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/apis, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-07-07"
  name = "string"
  body = {
    authenticationSettings = {
      oAuth2 = {
        authorizationServerId = "string"
        scope = "string"
      }
    }
    description = "string"
    path = "string"
    protocols = [
      "string"
    ]
    serviceUrl = "string"
    subscriptionKeyParameterNames = {
      header = "string"
      query = "string"
    }
  }
}

Valores da propriedade

AuthenticationSettingsContract

Nome Descrição Valor
oAuth2 Detalhes das configurações de Autenticação OAuth2 da API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrição Valor
authenticationSettings Coleção de configurações de autenticação incluídas nessa API. AuthenticationSettingsContract
descrição Descrição da API. Pode incluir marcas de formatação HTML. corda
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
caminho URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. corda

Restrições:
Comprimento máximo = 400 (obrigatório)
Protocolos Descreve em quais protocolos as operações nesta API podem ser invocadas. Matriz de cadeia de caracteres que contém qualquer um dos:
'Http'
'Https' (obrigatório)
serviceUrl URL absoluta do serviço de back-end que implementa essa API. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 2000 (obrigatório)
subscriptionKeyParameterNames Protocolos sobre os quais a API é disponibilizada. SubscriptionKeyParameterNamesContract
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis@2016-07-07"

OAuth2AuthenticationSettingsContract

Nome Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
âmbito escopo de operações. corda

SubscriptionKeyParameterNamesContract

Nome Descrição Valor
cabeçalho Nome do cabeçalho da chave de assinatura. corda
consulta Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. corda