Definir parâmetro de cadeia de consulta
APLICA-SE A: Todas as camadas de gerenciamento de API
A set-query-parameter política adiciona, substitui o valor de, ou exclui o parâmetro de cadeia de caracteres de consulta de solicitação. Pode ser usado para passar parâmetros de consulta esperados pelo serviço de back-end que são opcionais ou nunca estão presentes na solicitação.
Nota
Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Para ajudá-lo a configurar essa política, o portal fornece um editor guiado baseado em formulários. Saiba mais sobre como definir ou editar políticas de Gerenciamento de API.
Declaração de política
<set-query-parameter name="param name" exists-action="override | skip | append | delete">
<value>value</value> <!--for multiple parameters with the same name add additional value elements-->
</set-query-parameter>
Atributos
| Nome | Descrição | Necessário | Predefinição |
|---|---|---|---|
| existe-ação | Especifica a ação a tomar quando o parâmetro da consulta já foi especificado. Esse atributo deve ter um dos seguintes valores. - override - substitui o valor do parâmetro existente.- skip - não substitui o valor do parâmetro de consulta existente.- append - acrescenta o valor ao valor do parâmetro de consulta existente.- delete - Remove o parâmetro de consulta da solicitação.Quando definido para override inscrever várias entradas com o mesmo nome, o parâmetro de consulta será definido de acordo com todas as entradas (que serão listadas várias vezes), apenas os valores listados serão definidos no resultado.São permitidas expressões de política. |
Não | override |
| nome | Especifica o nome do parâmetro de consulta a ser definido. São permitidas expressões de política. | Sim | N/A |
Elementos
| Nome | Descrição | Necessário |
|---|---|---|
| valor | Especifica o valor do parâmetro da consulta a definir. Para vários parâmetros de consulta com o mesmo nome, adicione elementos adicionais value . São permitidas expressões de política. |
Sim |
Utilização
- Seções de política: entrada, back-end
- Âmbitos de política: global, área de trabalho, produto, API, operação
- Gateways: clássico, v2, consumo, auto-hospedado, espaço de trabalho
Exemplos
Definir valor do parâmetro de consulta
<set-query-parameter name="api-key" exists-action="skip">
<value>12345678901</value>
</set-query-parameter>
Definir parâmetro de consulta para encaminhar contexto para o back-end
Este exemplo mostra como aplicar a política no nível da API para fornecer informações de contexto ao serviço de back-end.
<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
<value>@(context.Product.Name)</value>
</set-query-parameter>
Para obter mais informações, consulte Expressões de política e variável de contexto.
Políticas relacionadas
Conteúdos relacionados
Para obter mais informações sobre como trabalhar com políticas, consulte:
- Tutorial: Transforme e proteja sua API
- Referência de política para uma lista completa de declarações de política e suas configurações
- Expressões de política
- Definir ou editar políticas
- Reutilizar configurações de política
- Recompra de trechos de política
- Criar políticas usando o Microsoft Copilot no Azure