Definir parámetro de cadena de consulta
SE APLICA A: Todos los niveles de API Management
La directiva set-query-parameter agrega o elimina el parámetro de cadena de consulta de la solicitud, o bien sustituye su valor. Se puede utilizar para pasar parámetros de consulta previstos por el servicio back-end que tienen carácter opcional o que nunca están presentes en la solicitud.
Nota
Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Para que pueda configurar esta directiva, el portal proporciona un editor guiado basado en formularios. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.
Instrucción de la directiva
<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>
Atributos
| Asignar nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
| exists-action | Especifica la acción que se debe realizar cuando ya se especifica un parámetro de consulta. Este atributo debe tener uno de los siguientes valores: - override: sustituye el valor del parámetro de consulta existente.- skip: no sustituye el valor del parámetro de consulta existente.- append: anexa el valor al del parámetro de consulta existente.- delete: quita el parámetro de consulta de la solicitud.Cuando se establece en override, se inscriben varias entradas con los resultados del mismo nombre del parámetro de consulta que se están estableciendo de acuerdo con todas las entradas (que se inscribirán varias veces); solo los valores mostrados se establecerán en el resultado.Se permiten expresiones de directiva. |
No | override |
| name | Especifica el nombre del parámetro de consulta que se debe establecer. Se permiten expresiones de directiva. | Sí | N/D |
Elementos
| Nombre | Descripción | Obligatorio |
|---|---|---|
| value | Especifica el valor del parámetro de consulta que se debe establecer. Para varios parámetros de consulta con el mismo nombre, agregue más elementos value. Se permiten expresiones de directiva. |
Sí |
Uso
- Secciones de la directiva: entrante y back-end
- Ámbitos de la directiva: global, área de trabajo, producto, API, operación
- Puertas de enlace: clásica, v2, consumo, autohospedada y área de trabajo
Ejemplos
Establecimiento del valor del parámetro de consulta
<set-query-parameter name="api-key" exists-action="skip">
<value>12345678901</value>
</set-query-parameter>
Establecimiento del parámetro de consulta para reenviar el contexto al back-end
En este ejemplo se muestra cómo aplicar directivas en el nivel de API para proporcionar información contextual al servicio 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>
Para obtener más información, consulte Policy expressions (Expresiones de política) y Context variable (Variable de contexto).
Directivas relacionadas
Contenido relacionado
Para más información sobre el trabajo con directivas, vea:
- Tutorial: Transformación y protección de una API
- Referencia de directivas para una lista completa de instrucciones de directivas y su configuración
- Expresiones de directiva
- Establecimiento o edición de directivas
- Reutilización de configuraciones de directivas
- Repositorio de fragmentos de código de directiva
- Creación de directivas mediante Microsoft Copilot en Azure