Nastavení parametru řetězce dotazu
PLATÍ PRO: Všechny úrovně služby API Management
Zásada set-query-parameter
přidá, nahradí hodnotu nebo odstraní parametr řetězce dotazu požadavku. Dá se použít k předávání parametrů dotazu očekávaných back-endovou službou, které jsou volitelné nebo se v požadavku nikdy nenacházejí.
Poznámka:
Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách. Portál poskytuje průvodce editorem založeným na formulářích, který vám pomůže s konfigurací této zásady. Přečtěte si další informace o tom, jak nastavit nebo upravit zásady služby API Management.
Prohlášení o zásadách
<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>
Atributy
Jméno | Popis | Požaduje se | Výchozí |
---|---|---|---|
existuje-akce | Určuje, jakou akci provést, když je parametr dotazu již zadán. Tento atribut musí mít jednu z následujících hodnot. - override – nahradí hodnotu existujícího parametru.- skip – nenahrazuje stávající hodnotu parametru dotazu.- append – připojí hodnotu k existující hodnotě parametru dotazu.- delete – odebere parametr dotazu z požadavku.Pokud je nastavena možnost override zařazení více položek se stejným názvem, výsledkem je nastavení parametru dotazu podle všech položek (které budou uvedeny vícekrát); ve výsledku se nastaví pouze uvedené hodnoty.Výrazy zásad jsou povolené. |
No | override |
name | Určuje název parametru dotazu, který se má nastavit. Výrazy zásad jsou povolené. | Yes | – |
Elementy
Název | Popis | Povinní účastníci |
---|---|---|
hodnota | Určuje hodnotu parametru dotazu, který má být nastaven. Pro více parametrů dotazu se stejným názvem přidejte další value prvky. Výrazy zásad jsou povolené. |
Ano |
Využití
- Oddíly zásad: příchozí, back-end
- Obory zásad: globální, pracovní prostor, produkt, rozhraní API, operace
- Brány: Classic, v2, consumption, self-host, workspace
Příklady
Nastavení hodnoty parametru dotazu
<set-query-parameter name="api-key" exists-action="skip">
<value>12345678901</value>
</set-query-parameter>
Nastavení parametru dotazu pro předávání kontextu do back-endu
Tento příklad ukazuje, jak použít zásady na úrovni rozhraní API k poskytování kontextových informací back-endové službě.
<!-- 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>
Další informace naleznete v tématu Výrazy zásad a kontextová proměnná.
Související zásady
Související obsah
Další informace o práci se zásadami najdete v tématech:
- Kurz: Transformace a ochrana rozhraní API
- Referenční informace o zásadách pro úplný seznam prohlášení o zásadách a jejich nastavení
- Výrazy zásad
- Nastavení nebo úprava zásad
- Opakované použití konfigurací zásad
- Úložiště fragmentů zásad
- Sada nástrojů zásad služby Azure API Management
- Vytváření zásad pomocí Microsoft Copilotu v Azure