referência de política de Gerenciamento de API

  • Artigo

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

Esta seção fornece breves descrições e links para artigos de referência para todas as políticas de Gerenciamento de API. Os gateways de Gerenciamento de API que dão suporte a cada política estão indicados. Para obter exemplos e configurações de política detalhadas, confira os artigos de referência vinculados.

Para saber mais sobre políticas:

Importante

Limitar a taxa de chamadas por assinatura e definir a cota de uso por assinatura têm uma dependência na chave de assinatura. Não é necessária uma chave de assinatura quando outras políticas são aplicadas.

Limitação de taxa e cotas

Política Descrição Clássico V2 Consumo Auto-hospedado
Limitar a taxa de chamada por assinatura Impede picos de uso da API limitando a taxa de chamadas, por assinatura. Sim Sim Sim Yes
Limitar a taxa de chamadas por chave Impede picos de uso da API limitando a taxa de chamadas, por chave. Sim Sim Não Sim
Definir a cota de uso por assinatura Permite que você imponha um volume de chamada renovável ou de tempo de vida e/ou uma cota de largura de banda, por assinatura. Sim Sim Sim Yes
Definir cota de uso por chave Permite que você imponha um volume de chamada renovável ou de tempo de vida e/ou uma cota de largura de banda, por chave. Sim Não No Sim
Limitar simultaneidade Impede que as políticas embutidas sejam executadas por mais do que o número especificado de solicitações de cada vez. Sim Sim Sim Yes
Limitar o uso de token do Serviço OpenAI do Azure Evita picos de uso da API do OpenAI do Azure ao limitar os tokens do modelo de linguagem grande por chave calculada. Sim Sim Não No
Limitar o uso de token de API de modelo de linguagem grande Evita picos de uso da API de LLM (modelo de linguagem grande) ao limitar os tokens do LLM por chave calculada. Sim Sim Não Não

Autenticação e autorização

Política Descrição Clássico V2 Consumo Auto-hospedado
Verificar cabeçalho HTTP Impõe a existência e/ou o valor de um cabeçalho HTTP. Sim Sim Sim Yes
Obter contexto de autorização Obtém o contexto de autorização de uma conexão especificada com um provedor de credenciais configurado na instância de Gerenciamento de API. Sim Sim Sim Não
Restringir IP do autor da chamada Filtra (permite/nega) chamadas de endereços IP e/ou intervalos de endereços específicos. Sim Sim Sim Yes
Validar o token do Microsoft Entra Impõe a existência e a validade de um JWT do Microsoft Entra (anteriormente chamado de Azure Active Directory) extraído de um cabeçalho HTTP, parâmetro de consulta ou valor de token especificado. Sim Sim Sim Yes
Validar JWT Impõe a existência e a validade de um JWT extraído de um cabeçalho HTTP, parâmetro de consulta ou valor de token especificado. Sim Sim Sim Yes
Validar o certificado do cliente Impõe que um certificado apresentado por um cliente a uma instância de Gerenciamento de API corresponda às regras e declarações de validação especificadas. Sim Sim Sim Yes
Autenticar com o Basic Autentica com um serviço de back-end usando a autenticação Básica. Sim Sim Sim Yes
Autenticar com o certificado de cliente Autentica com um serviço de back-end usando certificados de cliente. Sim Sim Sim Yes
Autenticar com identidade gerenciada Autentica com um serviço de back-end usando uma identidade gerenciada. Sim Sim Sim Yes

Validação de conteúdo

Política Descrição Clássico V2 Consumo Auto-hospedado
Validar conteúdo Valida o tamanho ou o conteúdo de um corpo de solicitação ou resposta em um ou mais esquemas de API. Os formatos de esquema com suporte são JSON e XML. Sim Sim Sim Yes
Validar a solicitação do GraphQL Valida e autoriza uma solicitação para uma API do GraphQL. Sim Sim Sim Yes
Validar solicitação OData Valida uma solicitação para uma API OData para garantir a conformidade com a especificação OData. Sim Sim Sim Yes
Validar parâmetros Valida os parâmetros de cabeçalho, consulta ou caminho da solicitação no esquema da API. Sim Sim Sim Yes
Validar cabeçalhos Valida os cabeçalhos de resposta no esquema da API. Sim Sim Sim Yes
Validar código de status Valida os códigos de status HTTP em respostas ao esquema de API. Sim Sim Sim Yes

Roteiros

Política Descrição Clássico V2 Consumo Auto-hospedado
Encaminhar solicitação Encaminha a solicitação para o serviço de back-end. Sim Sim Sim Yes
Definir o serviço de back-end Altera a URL base do serviço de back-end de uma solicitação de entrada para uma URL ou um back-end. Fazer referência a um recurso de back-end permite gerenciar a URL base do serviço de back-end e outras configurações em um único local. Implemente também balanceamento de carga de tráfego em um conjunto de serviços de back-end e regras de disjuntores para proteger o back-end de muitas solicitações. Sim Sim Sim Yes
Definir proxy HTTP Permite rotear solicitações encaminhadas por meio de um proxy HTTP. Sim Sim Sim Yes

Cache

Política Descrição Clássico V2 Consumo Auto-hospedado
Obter do cache Executa a pesquisa de cache e retorna uma resposta em cache válida quando disponível. Sim Sim Sim Yes
Armazenar em cache Armazena em cache a resposta de acordo com a configuração de controle de cache especificada. Sim Sim Sim Yes
Obter valor do cache Recupera um item armazenado em cache por chave. Sim Sim Sim Yes
Armazenar valor no cache Armazena um item no cache por chave. Sim Sim Sim Yes
Remover valor do cache Remove um item no cache por chave. Sim Sim Sim Yes
Obter respostas armazenadas em cache das solicitações de API do OpenAI do Azure Executa a pesquisa no cache da API de OpenAI do Azure usando a pesquisa semântica e retorna uma resposta válida em cache quando disponível. Sim Sim Sim Yes
Armazenar respostas de solicitações da API do OpenAI do Azure no cache Armazena em cache a resposta de acordo com a configuração do cache da API do OpenAI do Azure. Sim Sim Sim Sim
Obter respostas armazenadas em cache de solicitações de API de modelo de linguagem grande Executa a pesquisa no cache de API de modelo de linguagem grande usando a pesquisa semântica e retorna uma resposta em cache válida quando disponível. Sim Sim Sim Sim
Armazenar em cache respostas de solicitações de API de modelo de linguagem grande Armazena em cache a resposta de acordo com a configuração de cache de API de modelo de linguagem grande. Sim Sim Sim Yes

Transformação

Política Descrição Clássico V2 Consumo Auto-hospedado
Definir método de solicitação Permite que você altere o método HTTP para uma solicitação. Sim Sim Sim Yes
Definir código de status Altera o código de status HTTP para o valor especificado. Sim Sim Sim Yes
Definir variável Persiste um valor em uma variável de contexto nomeada para acesso posterior. Sim Sim Sim Yes
Definir corpo Define o corpo da mensagem para uma solicitação ou resposta. Sim Sim Sim Yes
Definir cabeçalho HTTP Atribui um valor a uma resposta e/ou cabeçalho de resposta existente, ou adiciona uma nova resposta e/ou cabeçalho de resposta. Sim Sim Sim Yes
Definir parâmetro de cadeia de consulta Adiciona, substitui o valor ou exclui o parâmetro de cadeia de caracteres de consulta da solicitação. Sim Sim Sim Yes
Reescrever URL Converte a URL de uma solicitação de sua forma pública em sua forma esperada pelo serviço Web. Sim Sim Sim Yes
Converter JSON para XML Converte o corpo da solicitação ou resposta de JSON para XML. Sim Sim Sim Yes
Converter XML para JSON Converte o corpo da solicitação ou resposta de XML para JSON. Sim Sim Sim Yes
Localizar e substituir cadeia no corpo Encontra uma subcadeia de caracteres de uma solicitação ou resposta e a substitui por outra subcadeia de caracteres. Sim Sim Sim Yes
Mascarar URLs no conteúdo Reescreve links (máscaras) no corpo da resposta para que eles apontem para o link equivalente por meio do gateway. Sim Sim Sim Yes
Transformar XML usando um XSLT Aplica uma transformação XSL ao XML no corpo da solicitação ou resposta. Sim Sim Sim Yes
Retorno de resposta Anula a execução do pipeline e retorna a resposta especificada diretamente ao chamador. Sim Sim Sim Yes
Resposta simulada Anula a execução do pipeline e retorna uma resposta simulada diretamente ao chamador. Sim Sim Sim Yes

Domínio cruzado

Política Descrição Clássico V2 Consumo Auto-hospedado
Permitir chamadas entre domínios Torna a API acessível dos clientes baseados em navegador Adobe Flash e Microsoft Silverlight. Sim Sim Sim Yes
CORS Adiciona suporte para compartilhamento de recursos entre origens (CORS) a uma operação ou a uma API para permitir chamadas entre domínios de clientes baseados em navegador. Sim Sim Sim Yes
JSONP Adiciona suporte JSON com preenchimento (JSONP) a uma operação ou a uma API para permitir chamadas entre domínios de clientes baseados em navegador JavaScript. Sim Sim Sim Yes

Integração e comunicação externa

Política Descrição Clássico V2 Consumo Auto-hospedado
Enviar solicitação Envia uma solicitação para a URL especificada. Sim Sim Sim Yes
Enviar solicitação unidirecional Envia uma solicitação para a URL especificada sem aguardar uma resposta. Sim Sim Sim Yes
Fazer logon no hub de eventos Envia mensagens no formato especificado para um hub de eventos definido por uma entidade do Agente. Sim Sim Sim Yes
Enviar solicitação para um serviço (Dapr) Usa o runtime do Dapr para localizar e se comunicar de forma confiável com um microsserviço Dapr. Para saber mais sobre a invocação de serviço no Dapr, confira a descrição neste arquivo LEIAME. Não No No Sim
Enviar mensagem para o tópico Pub/Sub (Dapr) Usa o runtime do Dapr para publicar uma mensagem em um tópico Publicar/Assinar. Para saber mais sobre as mensagens de publicação/assinatura no Dapr, confira a descrição neste arquivo LEIAME. Não No No Sim
Associação de saída de gatilho (Dapr) Usa o runtime do Dapr para invocar um sistema externo por meio da associação de saída. Para saber mais sobre as associações no Dapr, confira a descrição neste arquivo LEIAME. Não No No Sim

Logging

Política Descrição Clássico V2 Consumo Auto-hospedado
Trace Adiciona rastreamentos personalizados à saída de rastreamento de solicitação no console de teste, dados telemétricos do Application Insights e logs de recursos. Yes Sim1 Sim Yes
Emitir métricas Envia métricas personalizadas para o Application Insights na execução. Sim Sim Sim Yes
Emitir métricas de token do OpenAI do Azure Envia métricas ao Application Insights sobre o consumo de tokens de modelo de linguagem grande por meio de APIs do Serviço OpenAI do Azure. Sim Sim Não Sim
Emitir métricas de token de API de modelo de linguagem grande Envia métricas ao Application Insights para o consumo de tokens de LLM (modelo de linguagem grande) por meio de APIs de LLM. Sim Sim Não Sim

1 No gateway V2, a política trace atualmente não adiciona a saída de rastreamento no console de teste.

Resolvedores do GraphQL

Política Descrição Clássico V2 Consumo Auto-hospedado
Fonte de dados do SQL do Azure para resolvedor Configura a solicitação SQL do Azure e a resposta opcional para resolver dados de um tipo de objeto e campo em um esquema do GraphQL. Sim Sim Não Não
Fonte de dados do Cosmos DB para resolvedor Configura a solicitação do Cosmos DB e a resposta opcional para resolver dados de um tipo de objeto e campo em um esquema do GraphQL. Sim Sim Não Não
Fonte de dados HTTP para resolvedor Configura a solicitação HTTP e, opcionalmente, a resposta HTTP para resolver dados para um tipo de objeto e campo em um esquema do GraphQL. Sim Sim Sim Não
Publicar evento na assinatura do GraphQL Publica um evento em uma ou mais assinaturas especificadas em um esquema de API do GraphQL. Configure a política em um Resolvedor GraphQL para um campo relacionado no esquema para outro tipo de operação, como uma mutação. Sim Sim Sim Não

Controle de política e fluxo

Política Descrição Clássico V2 Consumo Auto-hospedado
Fluxo de controle Aplica condicionalmente instruções de política com base nos resultados da avaliação de expressões boolianas. Sim Sim Sim Yes
Incluir fragmento Insere um fragmento de política na definição de política. Sim Sim Sim Yes
Repetir Tenta executar novamente as instruções de política embutidas, até que a condição seja atendida, se for. A execução será repetida em intervalos de tempo especificados até e a contagem de repetições especificada. Sim Sim Sim Yes
Aguardar Aguarda a conclusão da Solicitação de envio ou de Obter valor do cache ou das políticas de Fluxo de controle antes de continuar. Sim Sim Sim Yes

Conteúdo relacionado

Para obter mais informações sobre como trabalhar com políticas, consulte: