Parameter querytekenreeks instellen

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

Notitie

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

Beleidsverklaring

<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

Naam Beschrijving Vereist Standaard
exists-action Hiermee geeft u op welke actie moet worden uitgevoerd wanneer de querytekenreeks 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.

Als u meerdere override vermeldingen met dezelfde naam wilt inschakelen, wordt de queryparameter ingesteld op basis van alle vermeldingen (die meerdere keren worden weergegeven), worden alleen weergegeven waarden in het resultaat ingesteld.

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

Elementen

Naam Beschrijving Vereist
waarde Hiermee geeft u de waarde van de in te stellen queryparameter op. Voor meerdere queryparameters met dezelfde naam voegt u extra value elementen toe. Beleidsexpressies zijn toegestaan. Yes

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.

Volgende stappen

Zie voor meer informatie over het werken met beleid: