Partilhar via

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

Definição de recursos do bíceps

O tipo de recurso service/apis pode ser implantado com operações que visam:

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

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

Valores de propriedade

Microsoft.ApiManagement/service/apis

Designação Descrição Valor
authenticationSettings Coleção de configurações de autenticação incluídas nesta API. AuthenticationSettingsContract
Descrição Descrição da API. Pode incluir tags de formatação HTML. corda
Designação O nome do recurso cadeia de caracteres

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 para recurso do tipo: serviço
caminho URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da API especificada durante a criação da instância de serviço para formar uma URL pública para essa API. cadeia de caracteres

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 contendo qualquer uma das:
«Http»
'Https' (obrigatório)
URL do serviço URL absoluta do serviço de back-end que implementa esta API. cadeia de caracteres

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

AuthenticationSettingsContract

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

OAuth2AuthenticationSettingsContract

Designação Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
Âmbito de aplicação âmbito das operações. corda

SubscriptionKeyParameterNamesContract

Designação 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 ARM

O tipo de recurso service/apis pode ser implantado com operações que visam:

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

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

Valores de propriedade

Microsoft.ApiManagement/service/apis

Designação Descrição Valor
Versão da API A versão api '2016-10-10'
authenticationSettings Coleção de configurações de autenticação incluídas nesta API. AuthenticationSettingsContract
Descrição Descrição da API. Pode incluir tags de formatação HTML. corda
Designação O nome do recurso cadeia de caracteres

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

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 contendo qualquer uma das:
«Http»
'Https' (obrigatório)
URL do serviço URL absoluta do serviço de back-end que implementa esta API. cadeia de caracteres

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'

AuthenticationSettingsContract

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

OAuth2AuthenticationSettingsContract

Designação Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
Âmbito de aplicação âmbito das operações. corda

SubscriptionKeyParameterNamesContract

Designação 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 recursos Terraform (provedor AzAPI)

O tipo de recurso service/apis pode ser implantado com operações que visam:

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

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

Valores de propriedade

Microsoft.ApiManagement/service/apis

Designação Descrição Valor
authenticationSettings Coleção de configurações de autenticação incluídas nesta API. AuthenticationSettingsContract
Descrição Descrição da API. Pode incluir tags de formatação HTML. corda
Designação O nome do recurso cadeia de caracteres

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

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 contendo qualquer uma das:
«Http»
'Https' (obrigatório)
URL do serviço URL absoluta do serviço de back-end que implementa esta API. cadeia de caracteres

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-10-10"

AuthenticationSettingsContract

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

OAuth2AuthenticationSettingsContract

Designação Descrição Valor
authorizationServerId Identificador do servidor de autorização OAuth. corda
Âmbito de aplicação âmbito das operações. corda

SubscriptionKeyParameterNamesContract

Designação 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