Compartilhar via

Gateway de API no Gerenciamento de API do Azure

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo descreve as funções e os recursos do componente do gateway de Gerenciamento de API. Ele também compara os gateways que você pode implantar.

Informações relacionadas:

Função do gateway

O gateway de Gerenciamento de API (também chamado de plano de dados ou runtime) é o componente de serviço responsável por fazer proxy de solicitações de API, aplicar políticas e coletar telemetria.

Especificamente, o gateway:

Note

Todas as solicitações para o gateway de Gerenciamento de API, incluindo aquelas rejeitadas por configurações de política, contam para limites de taxa, cotas e limites de cobrança configurados se a camada de serviço as aplicar.

Gateways gerenciados e auto-hospedados

O Gerenciamento de API oferece gateways gerenciados e auto-hospedados:

  • Gerenciado – O gateway gerenciado é o componente de gateway padrão que o Azure implanta para cada instância de Gerenciamento de API em cada camada de serviço. Você também pode associar um gateway gerenciado autônomo a um workspace em uma instância de Gerenciamento de API em camadas de serviço selecionadas. Usando o gateway gerenciado, todo o tráfego de API flui pelo Azure, independentemente de onde os back-ends que implementam as APIs estão hospedados.

    Note

    Devido às diferenças na arquitetura de serviço subjacente, os gateways fornecidos nos diferentes níveis do Gerenciamento de API têm algumas diferenças de recursos. Para obter detalhes, confira a seção Comparação de recursos: gateways gerenciados versus auto-hospedados.

  • Auto-hospedado – O gateway auto-hospedado é uma versão opcional e em contêineres do gateway gerenciado padrão que está disponível em camadas de serviço selecionadas. Ele é útil para cenários híbridos e de várias nuvens em que há um requisito para executar os gateways do Azure nos mesmos ambientes em que os back-ends da API estão hospedados. O gateway auto-hospedado permite que os clientes com infraestrutura de TI híbrida gerenciem APIs hospedadas localmente e entre nuvens de um único serviço de Gerenciamento de API do Azure.

    • O gateway auto-hospedado é empacotado como um contêiner do Docker baseado em Linux e normalmente é implantado no Kubernetes, incluindo o Serviço de Kubernetes do Azure e os Kubernetes habilitados para Azure Arc.

    • Cada gateway auto-hospedado está associado a um recurso do Gateway em uma instância de Gerenciamento de API baseada em nuvem da qual recebe atualizações de configuração e comunica o status.

Comparação de recursos: gateways gerenciados versus auto-hospedados

As tabelas a seguir comparam os recursos disponíveis nos seguintes gateways do Gerenciamento de API:

  • Clássico: o gateway gerenciado disponível nos níveis Desenvolvedor, Básico, Standard e Premium (anteriormente agrupados como níveis dedicados)
  • V2 – o gateway gerenciado disponível nas camadas Basic v2, Standard v2 e Premium v2
  • Consumo: o gateway gerenciado disponível na nível Consumo
  • Auto-hospedado: o gateway auto-hospedado opcional disponível em alguns níveis
  • Espaço de trabalho - o gateway gerenciado disponível em um espaço de trabalho em níveis de serviço selecionados

Note

  • Alguns recursos de gateways gerenciados e auto-hospedados têm suporte apenas em determinadas camadas de serviço ou com determinados ambientes de implantação para gateways auto-hospedados.
  • Para verificar os recursos atualmente suportados do gateway auto-hospedado, verifique se você atualizou para a versão principal mais recente da imagem de contêiner do gateway auto-hospedado.
  • Confira também as limitações de gateway auto-hospedado.

Infraestrutura

Suporte de funcionalidades Classic V2 Consumo Self-hosted Workspace
Domínios personalizados ✔️ ✔️ ✔️ ✔️ ❌
Cache embutido ✔️ ✔️ ❌ ❌ ✔️
Cache externo compatível com Redis ✔️ ✔️ ✔️ ✔️ ❌
Injeção da rede virtual Desenvolvedor, Premium Premium v2 ❌ ✔️1,2 ✔️
Pontos de extremidade privados de entrada ✔️ Standard v2, Premium v2 ❌ ❌ ❌
Integração de rede virtual de saída ❌ Standard v2, Premium v2 ❌ ❌ ✔️
Zonas de Disponibilidade Premium Premium v2 ❌ ✔️1 ❌
implantação com várias regiões Premium ❌ ❌ ✔️1 ❌
Certificados raiz da AC para validação de certificado ✔️ ✔️6 ❌ ✔️3 ❌
Certificados de domínio gerenciado ✔️ ❌ ✔️ ❌ ❌
Configurações de protocolo TLS ✔️ ✔️ ✔️ ✔️ ❌
HTTP/2 (Cliente a gateway) ✔️4 ✔️4 ❌ ✔️ ❌
HTTP/2 (Gateway a back-end) ❌ ✔️5 ❌ ✔️5 ❌
Detecção de ameaças de API com o Defender para APIs ✔️ ✔️ ❌ ❌ ❌

1 Depende de como o gateway é implantado, mas é responsabilidade do cliente.
2 A conectividade com o ponto de extremidade de configuração do gateway auto-hospedado v2 requer a resolução DNS do nome do host do ponto de extremidade.
3 Os certificados raiz da Autoridade Certificadora (CA) para gateways auto-hospedados são gerenciados separadamente para cada gateway.
4Protocolo Cliente precisa ser habilitado.
5 Configurar usando a política de encaminhamento de solicitação.
6 Configurar detalhes do certificado de autoridade de certificação para autenticação de certificado no back-end nas configurações de back-end.

APIs de back-end

Suporte de funcionalidades Classic V2 Consumo Self-hosted Workspace
Especificação OpenAPI ✔️ ✔️ ✔️ ✔️ ✔️
Especificação da WSDL ✔️ ✔️ ✔️ ✔️ ✔️
Especificação de WADL ✔️ ✔️ ✔️ ✔️ ✔️
Aplicativo Lógico ✔️ ✔️ ✔️ ✔️ ✔️
Serviço de Aplicativo ✔️ ✔️ ✔️ ✔️ ✔️
Aplicativo de Funções ✔️ ✔️ ✔️ ✔️ ✔️
Aplicativo de contêiner ✔️ ✔️ ✔️ ✔️ ✔️
Service Fabric Desenvolvedor, Premium ❌ ❌ ❌ ❌
GraphQL de passagem ✔️ ✔️ ✔️ ✔️ ✔️
GraphQL sintético ✔️ ✔️ ✔️1 ✔️1 ❌
Passagem do WebSocket ✔️ ✔️ ❌ ✔️ ✔️
gRPC de passagem ❌ ❌ ❌ ✔️ ❌
OData ✔️ ✔️ ✔️ ✔️ ✔️
Azure OpenAI em modelos e LLMs do Microsoft Foundry ✔️ ✔️ ✔️ ✔️ ✔️
Servidor MCP de conexão direta ✔️ ✔️ ❌ ✔️ ❌
Exportar a API REST como servidor MCP ✔️ ✔️ ❌ ✔️ ❌
Agente A2A ❌ ✔️ ❌ ❌ ❌
Disjuntor no back-end ✔️ ✔️ ❌ ✔️ ✔️
Pool de back-end com balanceamento de carga ✔️ ✔️ ✔️ ✔️ ✔️

Policies

Os gateways gerenciados e auto-hospedados dão suporte a todas as políticas disponíveis em definições de política com as seguintes exceções. Consulte a referência de política para obter detalhes sobre cada política.

Suporte de funcionalidades Classic V2 Consumo Self-hosted1 Workspace
Integração do Dapr ❌ ❌ ❌ ✔️ ❌
Integração do Barramento de Serviço (versão prévia) ✔️ ❌ ❌ ❌ ❌
Resolvedores de GraphQL e validação de GraphQL ✔️ ✔️ ✔️ ❌ ❌
get-authorization-context ✔️ ✔️ ✔️ ❌ ❌
Autenticar com identidade gerenciada ✔️ ✔️ ✔️ ✔️ ❌
Cache semântico do Azure OpenAI e LLM ✔️ ✔️ ✔️ ❌ ❌
Cota e limite de taxa ✔️ ✔️ ✔️2 ✔️3 ✔️

1 As políticas configuradas sem suporte pelo gateway auto-hospedado são ignoradas durante a execução da política.
2 O limite de taxa por chave, cota por chave e políticas de limite de token de IA não estão disponíveis na camada de Consumo.
3 As contagens de limite de taxa em um gateway auto-hospedado podem ser configuradas para sincronizar localmente (entre instâncias de gateway em todos os nós de cluster), por exemplo, por meio da implantação do gráfico do Helm para Kubernetes ou usando os modelos de implantação do portal do Azure. No entanto, as contagens de limite de taxa não são sincronizadas com os outros recursos de gateway configurados na instância de Gerenciamento de API, incluindo o gateway gerenciado na nuvem. Saiba mais

Monitoring

Para obter detalhes sobre as opções de monitoramento, confira Observabilidade no Gerenciamento de API do Azure.

Suporte de funcionalidades Classic V2 Consumo Self-hosted Workspace
Análise de API ✔️ ✔️1 ❌ ❌ ❌
Application Insights ✔️ ✔️ ✔️ ✔️2 ✔️
Fazer logon por meio de Hubs de Eventos ✔️ ✔️ ✔️ ✔️ ✔️
Métricas no Azure Monitor ✔️ ✔️ ✔️ ✔️ ❌
Coletor do OpenTelemetry ❌ ❌ ❌ ✔️ ❌
Solicitar logs no Azure Monitor e no Log Analytics ✔️ ✔️ ❌ ❌ 3 ❌
Logs e métricas locais ❌ ❌ ❌ ✔️ ❌
Rastreamento de solicitação ✔️ ✔️ ✔️ ✔️ ✔️

1 os níveis v2 dão suporte à análise baseada no Azure Monitor.
2 O Gateway usa o buffer de memória interno do Azure Application Insight e não fornece garantias de entrega.
3 Atualmente, o gateway auto-hospedado não envia logs de recursos (logs de diagnóstico) para o Azure Monitor. Como opção, você pode enviar métricas para o Azure Monitor ou configurar e persistir logs localmente no local em que o gateway auto-hospedado é implantado.

Autenticação e autorização

Gateways gerenciados e auto-hospedados oferecem suporte a todas as opções de autenticação e autorização de API disponíveis, com as seguintes exceções.

Suporte de funcionalidades Classic V2 Consumo Self-hosted Workspace
Gerenciador de Credenciais ✔️ ✔️ ✔️ ❌ ❌

Taxa de transferência e escala de gateway

Important

A taxa de transferência depende de muitos fatores, incluindo o número e a taxa de conexões de cliente simultâneas, o tipo e o número de políticas configuradas, tamanhos de conteúdo, desempenho da API de back-end e outros fatores. A taxa de transferência do gateway auto-hospedado também depende da capacidade de computação (CPU e memória) do host em que ele é executado. Para determinar com precisão a taxa de transferência esperada, execute o teste de carga do gateway usando condições de produção previstas.

Gateway gerenciado

Para obter a taxa de transferência máxima estimada do gateway nas camadas de serviço Gerenciamento de API, confira Preços do Gerenciamento de API.

Important

Utilize os dados de produtividade apenas para fins informativos. Não confie neles para planejamento de capacidade e orçamento. Confira Preços do Gerenciamento de API para obter detalhes.

  • Níveis clássicos

    • Dimensione a capacidade do gateway adicionando e removendo unidades de escala ou atualizando a camada de serviço. (O dimensionamento não está disponível na camada de desenvolvedor.)
    • Nos níveis Standard e Premium, opcionalmente, configure a escala automática do Azure Monitor.
    • Como opção, na camada Premium, adicione e distribua a capacidade do gateway em várias regiões.

  • Níveis v2

  • Camada de consumo

    • As instâncias de Gerenciamento de API na camada de consumo são dimensionadas automaticamente com base no tráfego.

Gateway auto-hospedado

Gateway de workspace

Escala a capacidade adicionando e removendo unidades de escala no gateway do espaço de trabalho.

Ponto de verificação de saúde do gateway

Em todos os níveis, exceto no nível de Consumo, o API Management do Azure fornece um ponto de extremidade de verificação de integridade do gateway integrado no caminho /status-0123456789abcdef. Acesse este endpoint para ajudar a confirmar se o gateway de API está disponível e funcionando corretamente. Ele não testa APIs de back-end, apenas o próprio gateway.

Uma solicitação para o ponto de extremidade retorna uma 200 OK resposta HTTP quando o gateway está íntegro; falhas indicam problemas de rede ou gateway.

  • O Azure usa este endpoint internamente para monitoramento contínuo de SLA e validação de saúde do gateway.
  • Os clientes podem integrar solicitações para este ponto de extremidade em suas próprias ferramentas de monitoramento e investigação.
  • O ponto de extremidade está disponível para gateways gerenciados (incluindo gateways regionais em implantações de várias regiões), gateways auto-hospedados e gateways de área de trabalho.

Dica

Ao integrar o Azure Application Insights ao Gerenciamento de API, opcionalmente, você pode habilitar o monitoramento de disponibilidade do gateway. Essa configuração verifica regularmente o ponto de extremidade de verificação de integridade do gateway e relata os resultados na guia Disponibilidade no Application Insights.

Conteúdo relacionado

Saiba mais sobre:

  • Last updated on