referência de política de Gerenciamento de API
Esta seção fornece links para artigos de referência para todas as políticas de Gerenciamento de API.
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.
Políticas de restrição de acesso
- Verificar cabeçalho HTTP – impõe a existência e/ou o valor de um cabeçalho HTTP.
- Obter contexto de autorização – Obtém o contexto de autorização de uma autorização específica, configurada na instância do Gerenciamento de API.
- Limitar a taxa de chamada por assinatura - Previne picos de uso da API limitando a taxa de chamada, baseado em assinatura.
- Limitar a taxa de chamada por chave - Previne picos de uso da API limitando a taxa de chamada, baseado em chave.
- Restringir IP do autor da chamada - Filtra (permite/recusa) chamadas de endereços IP específicos e/ou intervalos de endereços.
- Definir a cota de uso por assinatura - Permite que você aplique uma cota renovável ou permanente de volume de chamada e/ou largura de banda, baseado em assinatura.
- Definir a cota de uso por chave - Permite que você aplique uma cota renovável ou permanente de volume de chamada e/ou largura de banda, baseado em chave.
- Validar o token do Azure Active Directory – impõe a existência e a validade de um JWT do Azure Active Directory extraído de um cabeçalho HTTP especificado, parâmetro de consulta ou valor de token.
- Validar JWT – impõe a existência e a validade de um JWT extraído de um cabeçalho HTTP, um parâmetro de consulta ou um valor do token.
- Validar certificado do cliente – impõe que um certificado apresentado por um cliente a uma instância de Gerenciamento de API corresponda às regras e às declarações de validação especificadas.
Políticas avançadas
- Controlar fluxo - Aplica-se condicionalmente a instruções de políticas com base nos resultados da avaliação do booliano expressions.
- Emitir métricas – envia métricas personalizadas para o Application Insights em execução.
- Encaminhar solicitação -Encaminha a solicitação ao serviço de back-end.
- Incluir fragmento – insere um fragmento de política na definição de política.
- Simultaneidade de limite - impede que as políticas embutidas sejam executadas mais do que o número especificado de solicitações por vez.
- Registrar no hub de eventos - envia mensagens no formato especificado para um hub de eventos definido por uma entidade Logger.
- Resposta fictícia – anula a execução de pipeline e retorna uma resposta fictícia diretamente para o chamador.
- Repetir - repete a execução das instruções de política, se e até que a condição seja atendida. A execução será repetida em intervalos de tempo especificados até e a contagem de repetições especificada.
- Retornar resposta - Anula a execução de pipeline e retorna a resposta especificada diretamente para o autor da chamada.
- Enviar solicitação unidirecional - Envia uma solicitação para a URL especificada sem aguardar uma resposta.
- Enviar solicitação - Envia uma solicitação para a URL especificada.
- Definir proxy HTTP – permite a você, por meio de um proxy HTTP, reencaminhar solicitações encaminhadas.
- Definir método de solicitação - Permite alterar o método HTTP de uma solicitação.
- Definir código de status – altera o código de status de HTTP para o valor especificado.
- Definir variável – persiste um valor em uma variável de contexto nomeada para acesso posterior.
- Rastreamento – adiciona rastreamentos personalizados à saída de rastreamento de solicitação no console de teste, telemetrias do Application Insights e logs de recursos.
- Aguardar – aguarda a conclusão das políticas Enviar solicitação, Obter valor do cache ou Controlar fluxo antes de continuar.
Políticas de autenticação
- Autenticar com o Basic - Autenticar com um serviço de back-end usando a autenticação Básica.
- Autenticar com o certificado de cliente - Autenticar com um serviço de back-end usando certificados de cliente.
- Autenticar-se com uma identidade gerenciada – autentique-se com um serviço de back-end usando uma identidade gerenciada.
Políticas de caching
- Obter do cache - executa a pesquisa em cache e retorna uma resposta válida armazenada em cache quando disponível.
- Armazenar em cache - Armazena a resposta em cache de acordo com a configuração de controle de cache especificada.
- Obter valor do cache - Recupere um item em cache por chave.
- Armazenar valor em cache -Armazene um item no cache por chave.
- Remover o valor do cache - remove um item no cache por chave.
Políticas entre domínios
- Permitir chamadas entre domínios - Torna a API acessível por meio de clientes Adobe Flash e Microsoft Silverlight baseados em navegadores.
- CORS - Adicionar suporte de compartilhamento de recursos entre origens (CORS) a uma operação ou a uma API para permitir chamadas entre domínios de clientes baseados em navegadores.
- JSONP - Adiciona suporte JSON com preenchimento (JSONP) a uma operação ou a uma API para permitir chamadas entre domínios de clientes JavaScript baseados em navegadores.
Políticas de integração de Dapr
- Enviar solicitação para um serviço: usa o runtime do Dapr para localizar e se comunicar de maneira confiável com um microsserviço do Dapr. Para saber mais sobre a invocação de serviço no Dapr, confira a descrição neste arquivo LEIAME.
- Enviar mensagem para o tópico de Publicação/Assinatura: usa o runtime do Dapr para publicar uma mensagem em um tópico de publicação/assinatura. Para saber mais sobre as mensagens de publicação/assinatura no Dapr, confira a descrição neste arquivo LEIAME.
- Disparar associação de saída: 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.
Políticas de API do GraphQL
- Validar solicitação do GraphQL: valida e autoriza uma solicitação para uma API do GraphQL.
- Definir resolvedor do GraphQL: recupera ou define dados para um campo do GraphQL em um tipo de objeto especificado em um esquema do GraphQL.
Políticas de transformação
- Converter JSON para XML – converte o corpo da solicitação ou da resposta de JSON para XML.
- Converter XML para JSON – converte o corpo da solicitação ou da resposta de XML para JSON.
- Localizar e substituir cadeia de caracteres no corpo – localiza uma subcadeia de caracteres de solicitação ou de resposta e a substitui por outra subcadeia de caracteres.
- Mascarar URLs no conteúdo – Reescreve (mascara) os links no corpo da resposta, para que eles apontem para o link equivalente por meio do gateway.
- Definir o serviço de back-end - Altera o serviço de back-end para uma solicitação de entrada.
- Definir corpo - Define o corpo da mensagem para solicitações de entrada e saída.
- 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.
- Definir parâmetro de cadeia de consulta - Adiciona, substitui o valor ou exclui parâmetros de cadeias de consulta de solicitação.
- Reescrever URL – converte a URL de uma solicitação de sua forma pública para a forma esperada pelo serviço Web.
- Transformar XML usando um XSLT – aplica uma transformação XSL para XML no corpo da solicitação ou resposta.
Políticas de validação
- Validar conteúdo – valida o tamanho ou o conteúdo de um corpo de resposta ou solicitação em relação a um ou mais esquemas de API. Os formatos de esquema com suporte são JSON e XML.
- Validar parâmetros – valida os parâmetros de cabeçalho, consulta ou caminho da solicitação em relação ao esquema da API.
- Validar cabeçalhos – valida os cabeçalhos da resposta em relação ao esquema de API.
- Validar o código de status – valida os códigos de status HTTP em
Próximas etapas
Para obter mais informações sobre como trabalhar com políticas, consulte: