Partilhar via

API Management policy reference (Referência de política da Gestão de API)

  • Artigo

APLICA-SE A: Todas as camadas de 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 suportam cada política são indicados. Para obter configurações de política detalhadas e exemplos, consulte os artigos de referência vinculados.

Mais informações sobre políticas:

Importante

Limitar a taxa de chamadas por subscrição e Definir quota de utilização por subscrição dependem da chave de subscrição. Uma chave de assinatura não é necessária quando outras políticas são aplicadas.

Limitação das taxas e quotas

Política Description Clássico V2 Consumo Autoalojado
Limitar a taxa de chamadas por subscrição Evita picos de uso da API limitando a taxa de chamadas, por assinatura. Sim Sim Sim Sim
Limitar a taxa de chamadas por chave Evita picos de uso da API limitando a taxa de chamadas, por chave. Sim Sim No Sim
Definir quota de utilização por subscrição Permite que você imponha um volume de chamadas renovável ou vitalício e/ou uma cota de largura de banda, por assinatura. Sim Sim Sim Sim
Definir cota de uso por chave Permite que você imponha um volume de chamadas renovável ou vitalício e/ou uma cota de largura de banda, por chave. Sim No No Sim
Limitar a simultaneidade Impede que as políticas incluídas sejam executadas por mais do que o número especificado de solicitações de cada vez. Sim Sim Sim Sim
Limitar o uso do token do Serviço OpenAI do Azure Impede picos de uso da API OpenAI do Azure limitando tokens de modelo de linguagem grandes por chave calculada. Sim Sim No Não
Limitar o uso de token de API de modelo de linguagem grande Evita picos de uso de API de modelo de linguagem grande (LLM) limitando tokens LLM por chave calculada. Sim Sim No Não

Autenticação e autorização

Política Description Clássico V2 Consumo Autoalojado
Verifique o cabeçalho HTTP Impõe a existência e/ou o valor de um cabeçalho HTTP. Sim Sim Sim Sim
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 No
Restringir IPs do chamador Filtra (permite/nega) chamadas de endereços IP e/ou intervalos de endereços específicos. Sim Sim Sim Sim
Validar token do Microsoft Entra Impõe a existência e a validade de um JWT do Microsoft Entra (anteriormente chamado Azure Ative Directory) extraído de um cabeçalho HTTP especificado, parâmetro de consulta ou valor de token. Sim Sim Sim Sim
Validar JWT Impõe a existência e a validade de um JWT extraído de um cabeçalho HTTP especificado, parâmetro de consulta ou valor de token. Sim Sim Sim Sim
Validar certificado de cliente Impõe que um certificado apresentado por um cliente a uma instância de Gerenciamento de API corresponda às regras de validação e declarações especificadas. Sim Sim Sim Sim
Autenticar com Basic Autentica com um serviço de back-end usando a autenticação Básica. Sim Sim Sim Sim
Autenticar com certificado de cliente Autentica com um serviço de back-end usando certificados de cliente. Sim Sim Sim Sim
Autenticar com identidade gerenciada Autentica com um serviço de back-end usando uma identidade gerenciada. Sim Sim Sim Sim

Validação de conteúdo

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

Encaminhamento

Política Description Clássico V2 Consumo Autoalojado
Encaminhar pedido Encaminha a solicitação para o serviço de back-end. Sim Sim Sim Sim
Definir 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. A 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 lugar. Implemente também o balanceamento de carga do tráfego em um pool de serviços de back-end e regras de disjuntor para proteger o back-end de muitas solicitações. Sim Sim Sim Sim
Definir proxy HTTP Permite rotear solicitações encaminhadas por meio de um proxy HTTP. Sim Sim Sim Sim

Colocação em cache

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

Transformação

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

Entre domínios

Política Description Clássico V2 Consumo Autoalojado
Permitir chamadas entre domínios Torna a API acessível a partir de clientes baseados em navegador Adobe Flash e Microsoft Silverlight. Sim Sim Sim Sim
CORS Adiciona suporte a 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 Sim
JSONP Adiciona JSON com suporte a preenchimento (JSONP) a uma operação ou uma API para permitir chamadas entre domínios de clientes baseados em navegador JavaScript. Sim Sim Sim Sim

Integração e comunicação externa

Política Description Clássico V2 Consumo Autoalojado
Enviar pedido Envia uma solicitação para a URL especificada. Sim Sim Sim Sim
Enviar pedido unidirecional Envia uma solicitação para a URL especificada sem esperar por uma resposta. Sim Sim Sim Sim
Iniciar sessão no hub de eventos Envia mensagens no formato especificado para um hub de eventos definido por uma entidade Logger. Sim Sim Sim Sim
Enviar solicitação para um serviço (Dapr) Usa o tempo de execução do Dapr para localizar e se comunicar de forma confiável com um microsserviço do Dapr. Para saber mais sobre a invocação de serviço no Dapr, consulte a descrição neste arquivo LEIA-ME . No No No Sim
Enviar mensagem para Pub/Sub topic (Dapr) Usa o tempo de execução do Dapr para publicar uma mensagem em um tópico Publicar/Assinar. Para saber mais sobre Publicar/Assinar mensagens no Dapr, consulte a descrição neste arquivo LEIA-ME . No No No Sim
Ligação de saída de gatilho (Dapr) Usa o tempo de execução do Dapr para invocar um sistema externo por meio da vinculação de saída. Para saber mais sobre ligações no Dapr, consulte a descrição neste arquivo LEIA-ME . No No No Sim

Registo

Política Description Clássico V2 Consumo Autoalojado
Rastreio Adiciona rastreamentos personalizados à saída de rastreamento de solicitação no console de teste, telemetrias do Application Insights e logs de recursos. Sim Sim1 Sim Sim
Métricas de emissão Envia métricas personalizadas para o Application Insights na execução. Sim Sim Sim Sim
Emitir métricas de token OpenAI do Azure Envia métricas para o Application Insights para consumo de tokens de modelo de linguagem grande por meio de APIs de serviço do Azure OpenAI. Sim Sim No Sim
Emitir métricas de token de API de modelo de linguagem grande Envia métricas para o Application Insights para consumo de tokens de modelo de linguagem grande (LLM) por meio de APIs LLM. Sim Sim No Sim

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

Resolvedores GraphQL

Política Description Clássico V2 Consumo Autoalojado
Fonte de dados SQL do Azure para resolver Configura a solicitação SQL do Azure e a resposta opcional para resolver dados para um tipo de objeto e campo em um esquema GraphQL. Sim Sim No Não
Fonte de dados do Cosmos DB para resolvedor Configura a solicitação do Cosmos DB e a resposta opcional para resolver dados para um tipo de objeto e campo em um esquema GraphQL. Sim Sim No 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 GraphQL. Sim Sim Sim No
Publicar evento na assinatura do GraphQL Publica um evento para 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 No

Controlo e fluxo de políticas

Política Description Clássico V2 Consumo Autoalojado
Fluxo de controlo Condicionalmente aplica declarações de política com base nos resultados da avaliação de expressões booleanas. Sim Sim Sim Sim
Incluir fragmento Insere um fragmento de política na definição de política. Sim Sim Sim Sim
Repetir Tenta executar novamente as declarações de política anexadas, se e até que a condição seja atendida. A execução será repetida nos intervalos de tempo especificados e até a contagem de repetições especificada. Sim Sim Sim Sim
Wait Aguarda a conclusão de políticas de Enviar solicitação, Obter valor do cache ou Controlar o fluxo antes de prosseguir. Sim Sim Sim Sim

Conteúdos relacionados

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