Definir parâmetro de cadeia de caracteres de consulta

  • Artigo

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

A política set-query-parameter adiciona, substitui o valor ou exclui parâmetros de cadeias de consulta de solicitação. Pode ser usada para transmitir parâmetros de consulta esperados pelo serviço de back-end que são opcionais ou nunca estão presentes na solicitação.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Para ajudá-lo a configurar essa política, o portal fornece um editor guiado baseado em formulário. Saiba mais sobre como definir e editar as 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

Name Descrição Obrigatório Padrão
exists-action Especifica a ação a ser adotada quando o parâmetro de consulta já foi especificado. Este atributo deve ter um dos valores a seguir.

- 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 como override, listar diversas entradas com o mesmo nome faz com que o parâmetro de consulta seja definido de acordo com todas as entradas (que serão listadas várias vezes); somente valores listados serão definidos no resultado.

Expressões de política são permitidas.		 Não override
name Especifica o nome do parâmetro de consulta a ser definido. Expressões de política são permitidas. Sim N/D

Elementos

Nome Descrição Obrigatório
value Especifica o valor do parâmetro de consulta a ser definido. Para adicionar vários parâmetros de consulta com o mesmo nome, adicione elementos value adicionais. Expressões de política são permitidas. Sim

Uso

Exemplos

Definir valor do parâmetro de consulta


<set-query-parameter name="api-key" exists-action="skip">
  <value>12345678901</value>
</set-query-parameter>

Definir o parâmetro de consulta para encaminhar o contexto para o back-end

Este exemplo mostra como aplicar a política no nível da API para fornecer informações de contexto para o 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, veja Expressões de política e Variável de contexto.

Conteúdo relacionado

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