Parameter voor querytekenreeks instellen

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

Met het set-query-parameter beleid wordt de waarde van de querytekenreeksparameter voor aanvragen toegevoegd, vervangen of verwijderd. Kan worden gebruikt om queryparameters door te geven die worden verwacht door de back-endservice die optioneel of nooit aanwezig zijn in de aanvraag.

Notitie

Stel de elementen en onderliggende elementen van het beleid in de volgorde in die in de beleidsverklaring is opgegeven. Om u te helpen dit beleid te configureren, biedt de portal een begeleide editor op basis van formulieren. Meer informatie over het instellen of bewerken van API Management-beleid.

Beleidsinstructie

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

Kenmerken

Meetcriterium Beschrijving Vereist Standaardinstelling
bestaat-actie Hiermee wordt opgegeven welke actie moet worden ondernomen als de queryparameter al is opgegeven. Dit kenmerk moet een van de volgende waarden hebben.

- override - vervangt de waarde van de bestaande parameter.
- skip - vervangt de bestaande queryparameterwaarde niet.
- append - voegt de waarde toe aan de bestaande queryparameterwaarde.
- delete - verwijdert de queryparameter uit de aanvraag.

Wanneer deze instelling is ingesteld op override het inschakelen van meerdere vermeldingen met dezelfde naam, wordt de queryparameter ingesteld op basis van alle vermeldingen (die meerdere keren worden vermeld). Alleen vermelde waarden worden in het resultaat ingesteld.

Beleidsexpressies zijn toegestaan.		 Nee override
naam Hiermee geeft u de naam van de queryparameter die moet worden ingesteld. Beleidsexpressies zijn toegestaan. Ja N.v.t.

Elementen

Name Beschrijving Vereist
waarde Hiermee wordt de waarde van de in te stellen queryparameter opgegeven. Voor meerdere queryparameters met dezelfde naam voegt u extra value elementen toe. Beleidsexpressies zijn toegestaan. Ja

Gebruik

Voorbeelden

Waarde van queryparameter instellen


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

Queryparameter instellen om context door te sturen naar de back-end

In dit voorbeeld ziet u hoe u beleid toepast op API-niveau om contextinformatie te leveren aan de back-endservice.

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

Zie Beleidsexpressies en contextvariabele voor meer informatie.

Gerelateerde inhoud

Zie voor meer informatie over het werken met beleid: