Compartilhar via


Serviço Microsoft.ApiManagement 2016-10-10

Definição de recurso do Bicep

O tipo de recurso de serviço 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, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AdditionalRegion

Nome Descrição Valor
localização O nome da localização da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade de SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU do Desenvolvedor é 1, para SKU Standard é 4 e para SKU Premium é 10, em um local. int

Restrições:
Valor máximo = 10
vpnconfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço de Gerenciamento de API. de Região Adicional []
addresserEmail Email do endereçador. corda
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração de nome de host personalizado do serviço de Gerenciamento de API. hostnameConfiguration[]
publisherEmail Email do publicador. corda

Restrições:
Comprimento máximo = (obrigatório)
publisherName Nome do editor. cadeia de caracteres (obrigatório)
vpnconfiguration Configuração de rede virtual do serviço de Gerenciamento de API. VirtualNetworkConfiguration
vpnType O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação de Gerenciamento de API está configurada dentro de uma Rede Virtual com um ponto de extremidade voltado para a Internet e interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com apenas um ponto de extremidade voltado para intranet. 'Externo'
'Interno'
'None'

ApiManagementServicePropertiesCustomProperties

Nome Descrição Valor

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU). O valor padrão é 1. int
nome Nome do Sku. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)

CertificateInformation

Nome Descrição Valor
caducidade Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
Assunto Assunto do certificado. cadeia de caracteres (obrigatório)
Impressão digital Impressão digital do certificado. cadeia de caracteres (obrigatório)

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. cadeia de caracteres (obrigatório)
tipo Tipo de nome de host. 'Gerenciamento'
'Portal'
'Proxy'
'Scm' (obrigatório)

Microsoft.ApiManagement/service

Nome Descrição Valor
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do serviço de Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
Sku Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

ResourceTags

Nome Descrição Valor

VirtualNetworkConfiguration

Nome Descrição Valor
localização O local da rede virtual. corda
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço de Gerenciamento de API. corda

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Gateway de Aplicativo com gerenciamento de API interno e de aplicativo Web Gateway de Aplicativo roteando o tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno), que atende a uma API Web hospedada em um Aplicativo Web do Azure.
Criar uma instância de Gerenciamento de API de camada Premium de várias regiões Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local primário é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e Leste dos EUA2. O local primário deve ser diferente dos locais adicionais.
Criar uma instância de Gerenciamento de API com o MSI Identity Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure com uma identidade msi
Criar uma instância de Gerenciamento de API usando um modelo Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure
criar um serviço de Gerenciamento de API com um ponto de extremidade privado Esse modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço de Gerenciamento de API à rede virtual.
Criar um serviço de Gerenciamento de API com SSL do KeyVault Esse modelo implanta um serviço de Gerenciamento de API configurado com a Identidade Atribuída pelo Usuário. Ele usa essa identidade para buscar o certificado SSL do KeyVault e o mantém atualizado verificando a cada 4 horas.
criar gerenciamento de API na VNet interna com o Gateway de Aplicativo Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
implantar o Gerenciamento de API na VNet externa com de IP público Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo externo e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público de sua assinatura.
implantar o Gerenciamento de API na VNet interna com ip público Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo interno e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público de sua assinatura.
implantar o gerenciamento de API em zonas de disponibilidade Este modelo cria uma instância premium do Gerenciamento de API do Azure e é implantado em uma Zona de Disponibilidade
implantar o Gerenciamento de API com um Cache do Azure externo para Redis Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.
Front Door Standard/Premium com origem do Gerenciamento de API Esse modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar que o tráfego veio por meio da origem do Front Door.

Definição de recurso de modelo do ARM

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

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AdditionalRegion

Nome Descrição Valor
localização O nome da localização da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade de SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU do Desenvolvedor é 1, para SKU Standard é 4 e para SKU Premium é 10, em um local. int

Restrições:
Valor máximo = 10
vpnconfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço de Gerenciamento de API. de Região Adicional []
addresserEmail Email do endereçador. corda
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração de nome de host personalizado do serviço de Gerenciamento de API. hostnameConfiguration[]
publisherEmail Email do publicador. corda

Restrições:
Comprimento máximo = (obrigatório)
publisherName Nome do editor. cadeia de caracteres (obrigatório)
vpnconfiguration Configuração de rede virtual do serviço de Gerenciamento de API. VirtualNetworkConfiguration
vpnType O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação de Gerenciamento de API está configurada dentro de uma Rede Virtual com um ponto de extremidade voltado para a Internet e interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com apenas um ponto de extremidade voltado para intranet. 'Externo'
'Interno'
'None'

ApiManagementServicePropertiesCustomProperties

Nome Descrição Valor

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU). O valor padrão é 1. int
nome Nome do Sku. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)

CertificateInformation

Nome Descrição Valor
caducidade Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
Assunto Assunto do certificado. cadeia de caracteres (obrigatório)
Impressão digital Impressão digital do certificado. cadeia de caracteres (obrigatório)

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. cadeia de caracteres (obrigatório)
tipo Tipo de nome de host. 'Gerenciamento'
'Portal'
'Proxy'
'Scm' (obrigatório)

Microsoft.ApiManagement/service

Nome Descrição Valor
apiVersion A versão da API '2016-10-10'
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do serviço de Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
Sku Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.ApiManagement/service'

ResourceTags

Nome Descrição Valor

VirtualNetworkConfiguration

Nome Descrição Valor
localização O local da rede virtual. corda
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço de Gerenciamento de API. corda

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Gateway de Aplicativo com gerenciamento de API interno e de aplicativo Web

Implantar no Azure
Gateway de Aplicativo roteando o tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno), que atende a uma API Web hospedada em um Aplicativo Web do Azure.
Criar uma instância de Gerenciamento de API de camada Premium de várias regiões

Implantar no Azure
Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local primário é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e Leste dos EUA2. O local primário deve ser diferente dos locais adicionais.
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando de modelo

Implantar no Azure
Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub entidades
Criar uma instância de Gerenciamento de API com o MSI Identity

Implantar no Azure
Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure com uma identidade msi
Criar uma instância de Gerenciamento de API usando um modelo

Implantar no Azure
Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure
Criar uma instância de Gerenciamento de API com nomes de host personalizados

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure com nome de host personalizado para portal e vários nomes de host personalizados para proxy
criar um serviço de Gerenciamento de API com um ponto de extremidade privado

Implantar no Azure
Esse modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço de Gerenciamento de API à rede virtual.
Criar um serviço de Gerenciamento de API com SSL do KeyVault

Implantar no Azure
Esse modelo implanta um serviço de Gerenciamento de API configurado com a Identidade Atribuída pelo Usuário. Ele usa essa identidade para buscar o certificado SSL do KeyVault e o mantém atualizado verificando a cada 4 horas.
Criar e monitorar a instância de Gerenciamento de API

Implantar no Azure
Este modelo cria uma instância do serviço de Gerenciamento de API do Azure e do workspace do Log Analytics e configura o monitoramento para seu serviço de Gerenciamento de API com o Log Analytics
criar gerenciamento de API na VNet interna com o Gateway de Aplicativo

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
Criar Gerenciamento de API com ssl de proxy personalizado usando o KeyVault

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure e configurar o nome do host personalizado para proxy com o certificado SSL do keyvault.
criar o Azure Front Door em frente ao Gerenciamento de API do Azure

Implantar no Azure
Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.
implantar o Gerenciamento de API na VNet externa com de IP público

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo externo e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público de sua assinatura.
implantar o Gerenciamento de API na VNet interna com ip público

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo interno e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público de sua assinatura.
implantar o gerenciamento de API em zonas de disponibilidade

Implantar no Azure
Este modelo cria uma instância premium do Gerenciamento de API do Azure e é implantado em uma Zona de Disponibilidade
implantar o Gerenciamento de API com um Cache do Azure externo para Redis

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.
Front Door Standard/Premium com origem do Gerenciamento de API

Implantar no Azure
Esse modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar que o tráfego veio por meio da origem do Front Door.

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

Valores de propriedade

AdditionalRegion

Nome Descrição Valor
localização O nome da localização da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade de SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU do Desenvolvedor é 1, para SKU Standard é 4 e para SKU Premium é 10, em um local. int

Restrições:
Valor máximo = 10
vpnconfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço de Gerenciamento de API. de Região Adicional []
addresserEmail Email do endereçador. corda
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração de nome de host personalizado do serviço de Gerenciamento de API. hostnameConfiguration[]
publisherEmail Email do publicador. corda

Restrições:
Comprimento máximo = (obrigatório)
publisherName Nome do editor. cadeia de caracteres (obrigatório)
vpnconfiguration Configuração de rede virtual do serviço de Gerenciamento de API. VirtualNetworkConfiguration
vpnType O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação de Gerenciamento de API está configurada dentro de uma Rede Virtual com um ponto de extremidade voltado para a Internet e interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com apenas um ponto de extremidade voltado para intranet. 'Externo'
'Interno'
'None'

ApiManagementServicePropertiesCustomProperties

Nome Descrição Valor

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implantadas do SKU). O valor padrão é 1. int
nome Nome do Sku. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)

CertificateInformation

Nome Descrição Valor
caducidade Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
Assunto Assunto do certificado. cadeia de caracteres (obrigatório)
Impressão digital Impressão digital do certificado. cadeia de caracteres (obrigatório)

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. cadeia de caracteres (obrigatório)
tipo Tipo de nome de host. 'Gerenciamento'
'Portal'
'Proxy'
'Scm' (obrigatório)

Microsoft.ApiManagement/service

Nome Descrição Valor
localização Local do recurso. cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obrigatório)
Propriedades Propriedades do serviço de Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
Sku Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.ApiManagement/service@2016-10-10"

ResourceTags

Nome Descrição Valor

VirtualNetworkConfiguration

Nome Descrição Valor
localização O local da rede virtual. corda
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço de Gerenciamento de API. corda

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$