Partilhar via

Serviço Microsoft.ApiManagement 2016-07-07

  • Artigo

Definição de recursos do bíceps

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

resource symbolicname 'Microsoft.ApiManagement/service@2016-07-07' = {
  etag: 'string'
  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

Região Adicional

Designação Descrição Valor
Localização O nome do local da região adicional entre as regiões do Data Center do Azure. string (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU de desenvolvedor é 1, para SKU padrão é 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

ApiManagementServiceBaseParametersTags

Designação Descrição Valor

ApiManagementServiceProperties

Designação Descrição Valor
adicionalLocalizações Locais de datacenter adicionais do serviço de Gerenciamento de API. AdicionalRegião[]
endereçadorE-mail E-mail do destinatário. string
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração personalizada de nome de host do serviço de Gerenciamento de API. HostnameConfiguration[]
publisherE-mail E-mail do editor. string

Restrições:
Comprimento máximo = (obrigatório)
Nome do editor Nome do editor. string (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 do Gerenciamento de API é 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 um Ponto de Extremidade Voltado para a Intranet apenas. 'Externo'
'Interna'
'Nenhuma'

ApiManagementServicePropertiesCustomProperties

Designação Descrição Valor

ApiManagementServiceSkuProperties

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

CertificateInformation

Designação Descrição Valor
expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601. string (obrigatório)
Assunto Objeto do certificado. string (obrigatório)
impressão digital Impressão digital do certificado. string (obrigatório)

HostnameConfiguration

Designação Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. string (obrigatório)
tipo Tipo de nome de host. 'Gestão'
'Portal'
'Procuração'
'Scm' (obrigatório)

Microsoft.ApiManagement/serviço

Designação Descrição Valor
etag ETag do recurso. string
Localização Localização do datacenter do serviço de Gerenciamento de API. string (obrigatório)
Designação O nome do recurso string

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
SKU Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

VirtualNetworkConfiguration

Designação Descrição Valor
Localização A localização da rede virtual. string
subnetResourceId O nome da ID do recurso da sub-rede. Isso tem o formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede ClassicNetwork}/VirtualNetworks/{nome da rede virtual}/subnets/{nome da sub-rede}. string

Exemplos de início rápido

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

Arquivo Bicep Descrição
Application Gateway com gerenciamento interno de API e de aplicativos Web Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.
Criar uma instância de Gerenciamento de API de camada Premium multirregional Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local principal é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e East US2. O local principal 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 Este 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 a partir do KeyVault Este modelo implanta um serviço de Gerenciamento de API configurado com 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 em rede virtual interna com do App Gateway 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 em VNet externa 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 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 da sua assinatura.
Implantar o Gerenciamento de API em 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 da 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 implanta 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.
Porta Frontal Standard/Premium com origem API Management Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door.

Definição de recurso de modelo ARM

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

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-07-07",
  "name": "string",
  "etag": "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

Região Adicional

Designação Descrição Valor
Localização O nome do local da região adicional entre as regiões do Data Center do Azure. string (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU de desenvolvedor é 1, para SKU padrão é 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

ApiManagementServiceBaseParametersTags

Designação Descrição Valor

ApiManagementServiceProperties

Designação Descrição Valor
adicionalLocalizações Locais de datacenter adicionais do serviço de Gerenciamento de API. AdicionalRegião[]
endereçadorE-mail E-mail do destinatário. string
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração personalizada de nome de host do serviço de Gerenciamento de API. HostnameConfiguration[]
publisherE-mail E-mail do editor. string

Restrições:
Comprimento máximo = (obrigatório)
Nome do editor Nome do editor. string (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 do Gerenciamento de API é 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 um Ponto de Extremidade Voltado para a Intranet apenas. 'Externo'
'Interna'
'Nenhuma'

ApiManagementServicePropertiesCustomProperties

Designação Descrição Valor

ApiManagementServiceSkuProperties

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

CertificateInformation

Designação Descrição Valor
expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601. string (obrigatório)
Assunto Objeto do certificado. string (obrigatório)
impressão digital Impressão digital do certificado. string (obrigatório)

HostnameConfiguration

Designação Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. string (obrigatório)
tipo Tipo de nome de host. 'Gestão'
'Portal'
'Procuração'
'Scm' (obrigatório)

Microsoft.ApiManagement/serviço

Designação Descrição Valor
apiVersion A versão api '2016-07-07'
etag ETag do recurso. string
Localização Localização do datacenter do serviço de Gerenciamento de API. string (obrigatório)
Designação O nome do recurso string

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
SKU Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.ApiManagement/serviço'

VirtualNetworkConfiguration

Designação Descrição Valor
Localização A localização da rede virtual. string
subnetResourceId O nome da ID do recurso da sub-rede. Isso tem o formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede ClassicNetwork}/VirtualNetworks/{nome da rede virtual}/subnets/{nome da sub-rede}. string

Modelos de início rápido

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

Modelo Descrição
Application Gateway com gerenciamento interno de API e de aplicativos Web

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

Implantar no Azure 		Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local principal é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e East US2. O local principal deve ser diferente dos locais adicionais.
Crie uma instância de Gerenciamento de API e todos os subrecursos usando o modelo

Implantar no Azure 		Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
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 		Este 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 a partir do KeyVault

Implantar no Azure 		Este modelo implanta um serviço de Gerenciamento de API configurado com 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 espaço de trabalho do Log Analytics e configura o monitoramento para seu serviço de Gerenciamento de API com o Log Analytics
Criar gerenciamento de API em rede virtual interna com do App Gateway

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 proxy ssl personalizado usando KeyVault

Implantar no Azure 		Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure e configurar o nome de host personalizado para proxy com certificado ssl do keyvault.
Criar a Porta da Frente do Azure em frente ao de 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 em VNet externa 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 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 da sua assinatura.
Implantar o Gerenciamento de API em 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 da 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 implanta 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.
Porta Frontal Standard/Premium com origem API Management

Implantar no Azure 		Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door.

Definição de recursos Terraform (provedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-07-07"
  name = "string"
  etag = "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

Região Adicional

Designação Descrição Valor
Localização O nome do local da região adicional entre as regiões do Data Center do Azure. string (obrigatório)
skuType O tipo de SKU no local. 'Desenvolvedor'
'Premium'
'Standard' (obrigatório)
skuUnitCount A contagem da Unidade SKU no local. A contagem máxima de unidades de SKU depende do SkuType. O máximo permitido para SKU de desenvolvedor é 1, para SKU padrão é 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

ApiManagementServiceBaseParametersTags

Designação Descrição Valor

ApiManagementServiceProperties

Designação Descrição Valor
adicionalLocalizações Locais de datacenter adicionais do serviço de Gerenciamento de API. AdicionalRegião[]
endereçadorE-mail E-mail do destinatário. string
customProperties Propriedades personalizadas do serviço de Gerenciamento de API, como desabilitar o TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Configuração personalizada de nome de host do serviço de Gerenciamento de API. HostnameConfiguration[]
publisherE-mail E-mail do editor. string

Restrições:
Comprimento máximo = (obrigatório)
Nome do editor Nome do editor. string (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 do Gerenciamento de API é 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 um Ponto de Extremidade Voltado para a Intranet apenas. 'Externo'
'Interna'
'Nenhuma'

ApiManagementServicePropertiesCustomProperties

Designação Descrição Valor

ApiManagementServiceSkuProperties

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

CertificateInformation

Designação Descrição Valor
expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601. string (obrigatório)
Assunto Objeto do certificado. string (obrigatório)
impressão digital Impressão digital do certificado. string (obrigatório)

HostnameConfiguration

Designação Descrição Valor
certificado Informações do certificado. CertificateInformation (obrigatório)
nome do host Nome do host. string (obrigatório)
tipo Tipo de nome de host. 'Gestão'
'Portal'
'Procuração'
'Scm' (obrigatório)

Microsoft.ApiManagement/serviço

Designação Descrição Valor
etag ETag do recurso. string
Localização Localização do datacenter do serviço de Gerenciamento de API. string (obrigatório)
Designação O nome do recurso string

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
SKU Propriedades de SKU do serviço de Gerenciamento de API. ApiManagementServiceSkuProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.ApiManagement/service@2016-07-07"

VirtualNetworkConfiguration

Designação Descrição Valor
Localização A localização da rede virtual. string
subnetResourceId O nome da ID do recurso da sub-rede. Isso tem o formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede ClassicNetwork}/VirtualNetworks/{nome da rede virtual}/subnets/{nome da sub-rede}. string