Impostare il parametro di stringa della query
SI APPLICA A: Tutti i livelli di Gestione API
Il criterio set-query-parameter aggiunge, sostituisce il valore di o elimina il parametro di stringa della query di richiesta. Può essere usato per passare i parametri di query previsti dal servizio back-end che sono facoltativi o non sono mai presenti nella richiesta.
Nota
Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione del criterio. Per configurare questo criterio, il portale fornisce un editor guidato basato su moduli. Altre informazioni su come impostare o modificare i criteri di API Management.
Istruzione del criterio
<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>
Attributi
| Nome | Descrizione | Richiesto | Valore predefinito |
|---|---|---|---|
| exists-action | Specifica quale azione intraprendere quando il parametro di query è già stato specificato. Questo attributo deve avere uno dei valori seguenti. - override - sostituisce il valore del parametro esistente.- skip: non sostituisce il valore del parametro di query esistente.- append: aggiunge il valore del parametro di query esistente.- delete: elimina il parametro di query dalla richiesta.Se è impostato su override, l'integrazione di più voci con lo stesso nome avrà come risultato l'impostazione del parametro di query in base a tutte le voci, che saranno elencate più volte. Nel risultato saranno impostati solo i valori elencati.Le espressioni di criteri sono consentite. |
No | override |
| name | Specifica il nome del parametro di query da impostare. Le espressioni di criteri sono consentite. | Sì | N/D |
Elementi
| Nome | Descrizione | Richiesto |
|---|---|---|
| value | Specifica il valore del parametro di query da impostare. Se occorrono più parametri di query con lo stesso nome, aggiungere altri elementi value. Le espressioni di criteri sono consentite. |
Sì |
Utilizzo
- Sezioni del criterio: inbound, backend
- Ambiti del criterio: globale, area di lavoro, prodotto, API, operazione
- Gateway: classico, v2, consumo, self-hosted, area di lavoro
Esempi
Impostare il valore del parametro di query
<set-query-parameter name="api-key" exists-action="skip">
<value>12345678901</value>
</set-query-parameter>
Impostare il parametro di query per inoltrare il contesto al back-end
Questo esempio illustra come applicare criteri a livello di API per fornire informazioni di contesto al servizio 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>
Per altre informazioni, vedere Espressioni di criteri e Variabile di contesto.
Criteri correlati
Contenuto correlato
Per ulteriori informazioni sull'utilizzo dei criteri, vedere:
- Esercitazione: trasformare e proteggere l'API
- Informazioni di riferimento sui criteri per un elenco completo delle istruzioni dei criteri e delle relative impostazioni
- Espressioni di criteri
- Impostare o modificare criteri
- Riutilizzare le configurazioni dei criteri
- Repository dei frammenti di criteri
- Creare criteri usando Microsoft Copilot in Azure