Skip to content

set-query-parameter-policy.md

Latest commit

 

History

History
78 lines (52 loc) · 3.55 KB

set-query-parameter-policy.md

File metadata and controls

78 lines (52 loc) · 3.55 KB
title Azure API Management policy reference - set-query-parameter | Microsoft Docs
description Reference for the set-query-parameter policy available for use in Azure API Management. Provides policy usage, settings, and examples.
services api-management
author dlepow
ms.service azure-api-management
ms.topic reference
ms.date 07/23/2024
ms.author danlep

Set query string parameter

[!INCLUDE api-management-availability-all-tiers]

The set-query-parameter policy adds, replaces value of, or deletes request query string parameter. Can be used to pass query parameters expected by the backend service which are optional or never present in the request.

[!INCLUDE api-management-policy-form-alert]

Policy statement

<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>

Attributes

Name Description Required Default
exists-action Specifies what action to take when the query parameter is already specified. This attribute must have one of the following values.

- override - replaces the value of the existing parameter.
- skip - does not replace the existing query parameter value.
- append - appends the value to the existing query parameter value.
- delete - removes the query parameter from the request.

When set to override enlisting multiple entries with the same name results in the query parameter being set according to all entries (which will be listed multiple times); only listed values will be set in the result.

Policy expressions are allowed.		 No override
name Specifies name of the query parameter to be set. Policy expressions are allowed. Yes N/A

Elements

Name Description Required
value Specifies the value of the query parameter to be set. For multiple query parameters with the same name, add additional value elements. Policy expressions are allowed. Yes

Usage

Examples

Set value of query parameter

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

Set query parameter to forward context to the backend

This example shows how to apply policy at the API level to supply context information to the backend service.

<!-- 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>

For more information, see Policy expressions and Context variable.

Related policies

[!INCLUDE api-management-policy-ref-next-steps]