Gateway de API no Gerenciamento de API do Azure
APLICA-SE A: todas as camadas do Gerenciamento de API
Este artigo fornece informações sobre as funções e os recursos do componente do gateway de Gerenciamento de API e compara os gateways que você pode implantar.
Informações relacionadas:
Para obter uma visão geral dos cenários, componentes e conceitos de Gerenciamento de API, confira O que é o Gerenciamento de API do Azure?
Para obter mais informações sobre os níveis e os recursos do Gerenciamento de API, confira:
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:
- Atua como uma fachada para serviços de back-end aceitando chamadas à API e roteando-as para back-ends apropriados
- Verifica as chaves de API e outras credenciais, como tokens JWT e certificados apresentados com solicitações
- Impõe cotas de uso e limites de taxa
- Opcionalmente, transforma solicitações e respostas conforme especificado em instruções de política
- Se configurado, armazena em cache as respostas para aprimorar a latência de resposta e minimizar a carga nos serviços de back-end
- Emite logs, métricas e rastreamentos para monitoramento, relatórios e solução de problemas
Observação
Todas as solicitações para o gateway de Gerenciamento de API, incluindo aquelas rejeitadas pelas configurações de política, contam para limites de taxa, cotas e limites de cobrança configurados, se aplicados na camada de serviço.
Gerenciado e auto-hospedado
O Gerenciamento de API oferece gateways gerenciados e auto-hospedados:
Gerenciado: o gateway gerenciado é o componente de gateway padrão implantado no Azure para cada instância do Gerenciamento de API em cada camada de serviço. Com o gateway gerenciado, todo o tráfego de API flui pelo Azure, independentemente do local em que os back-ends que implementam as APIs estão hospedados.
Observação
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êiner do gateway gerenciado padrão disponível em níveis selecionados. 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.
Importante
O suporte para as imagens de contêiner do gateway auto-hospedado versão 0 e versão 1 do Gerenciamento de API do Azure termina em 1º de outubro de 2023, acompanhado da API de Configuração correspondente v1. Use nosso guia de migração para usar o gateway auto-hospedado v2.0.0 ou superior com a API de Configuração v2. Saiba mais em nossa documentação de reprovação
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 nos níveis Básico v2 e Standard v2
- Consumo: o gateway gerenciado disponível na nível Consumo
- Auto-hospedado: o gateway auto-hospedado opcional disponível em alguns níveis
Observação
- 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 os recursos atuais com suporte do gateway auto-hospedado, atualize 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 a recursos | Clássico | V2 | Consumo | Auto-hospedado |
|---|---|---|---|---|
| Domínios personalizados | ✔️ | ✔️ | ✔️ | ✔️ |
| Cache embutido | ✔️ | ✔️ | ❌ | ❌ |
| Cache externo compatível com Redis | ✔️ | ✔️ | ✔️ | ✔️ |
| Injeção da rede virtual | Desenvolvedor, Premium | ❌ | ❌ | ✔️1,2 |
| Pontos de extremidade privados de entrada | Desenvolvedor, Básico, Standard e Premium | ❌ | ❌ | ❌ |
| Integração de rede virtual de saída | ❌ | Padrão V2 | ❌ | ❌ |
| Zonas de Disponibilidade | Premium | ❌ | ❌ | ✔️1 |
| Implantação em várias regiões | Premium | ❌ | ❌ | ✔️1 |
| Certificados raiz da AC para validação de certificado | ✔️ | ✔️ | ❌ | ✔️3 |
| Certificados raiz da AC para validação de certificado | ✔️ | ✔️ | ❌ | ✔️3 |
| Certificados de domínio gerenciado | Desenvolvedor, Básico, Standard e Premium | ❌ | ✔️ | ❌ |
| Configurações de protocolo TLS | ✔️ | ✔️ | ✔️ | ✔️ |
| HTTP/2 (Cliente a gateway) | ✔️4 | ✔️4 | ❌ | ✔️ |
| HTTP/2 (Gateway a back-end) | ❌ | ❌ | ❌ | ✔️ |
| 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.
3Certificados raiz de AC do gateway auto-hospedado são gerenciados separadamente por gateway
4Protocolo Cliente precisa ser habilitado.
APIs de back-end
| Suporte a recursos | Clássico | V2 | Consumo | Auto-hospedado |
|---|---|---|---|---|
| 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 (versão prévia) | ❌ | ❌ | ❌ | ✔️ |
| OData (versão prévia) | ✔️ | ✔️ | ✔️ | ✔️ |
| GraphQL de passagem | ✔️ | ✔️ | ✔️ | ✔️ |
| OpenAI do Azure | ✔️ | ✔️ | ✔️ | ✔️ |
| Disjuntor no back-end (versão prévia) | ✔️ | ✔️ | ❌ | ✔️ |
| Pool de back-end com balanceamento de carga (versão prévia) | ✔️ | ✔️ | ✔️ | ✔️ |
1 assinaturas GraphQL sintéticas (versão prévia) não são compatíveis.
Políticas
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.
| Suporte a recursos | Clássico | V2 | Consumo | Auto-hospedado 1 |
|---|---|---|---|---|
| Integração do Dapr | ❌ | ❌ | ❌ | ✔️ |
| Resolvedores de GraphQL e validação de GraphQL | ✔️ | ✔️ | ✔️ | ❌ |
| Obter contexto de autorização | ✔️ | ✔️ | ✔️ | ❌ |
| Cota e limite de taxa | ✔️ | ✔️2 | ✔️3 | ✔️4 |
1 As políticas configuradas sem suporte pelo gateway auto-hospedado são ignoradas durante a execução da política.
2 A política de cota por chave não está disponível nos níveis v2.
2 O limite de taxa por chave e cota por políticas de chave 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
Monitoramento
Para obter detalhes sobre as opções de monitoramento, confira Observabilidade no Gerenciamento de API do Azure.
| Suporte a recursos | Clássico | V2 | Consumo | Auto-hospedado |
|---|---|---|---|---|
| Análise de API | ✔️ | ✔️1 | ❌ | ❌ |
| Application Insights | ✔️ | ✔️ | ✔️ | ✔️ |
| 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 | ✔️ | ✔️ | ❌ | ❌2 |
| Logs e métricas locais | ❌ | ❌ | ❌ | ✔️ |
| Rastreamento de solicitação | ✔️ | ❌3 | ✔️ | ✔️ |
1 os níveis v2 dão suporte à análise baseada no Azure Monitor.
2 Atualmente, o gateway auto-hospedado não envia logs de recursos (logs de diagnóstico) ao 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.
3 No momento, o rastreamento não está disponível nos níveis v2.
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 a recursos | Clássico | V2 | Consumo | Auto-hospedado |
|---|---|---|---|---|
| Gerenciador de Credenciais | ✔️ | ✔️ | ✔️ | ❌ |
Taxa de transferência e escala de gateway
Importante
A taxa de transferência é afetada pelo número e taxa de conexões de cliente simultâneas, o tipo e o número de políticas configuradas, tamanhos de carga, desempenho da API de back-end e outros fatores. A taxa de transferência de gateway auto-hospedado também depende da capacidade de computação (CPU e memória) do host em que ele é executado. Execute testes de carga de gateway usando condições de produção antecipadas para determinar a taxa de transferência esperada com precisão.
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.
Importante
Os números da taxa de transferência são apresentados apenas para informações e não devem ser confiados 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. (Escala não disponível na camada 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
- Dimensione a capacidade do gateway adicionando e removendo unidades de escala ou atualizando a camada de serviço.
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
- Em ambientes como o Kubernetes, adicione várias réplicas de gateway para lidar com o uso esperado.
- Opcionalmente, configure o dimensionamento automático para atender às demandas de tráfego.
Conteúdo relacionado
- Saiba mais sobre o Gerenciamento de API em um mundo híbrido e multicloud
- Saiba mais sobre como usar a métrica de capacidade para decisões de escala
- Saiba mais sobre os recursos de observação de gerenciamento de API