Comprobar encabezado HTTP
SE APLICA A: todos los niveles de API Management
Usa la directiva check-header
para exigir que una solicitud tenga un encabezado HTTP especificado. Si lo desea, puede comprobar si el encabezado tiene un valor específico o un intervalo de valores permitidos. Si el resultado de la comprobación es negativo, la directiva finaliza el procesamiento de la solicitud y devuelve el mensaje de error y el código de estado HTTP que especifica.
Nota:
Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.
Instrucción de la directiva
<check-header name="header name" failed-check-httpcode="code" failed-check-error-message="message" ignore-case="true | false">
<value>Value1</value>
<value>Value2</value>
</check-header>
Atributos
Atributo | Descripción | Necesario | Valor predeterminado |
---|---|---|---|
name | El nombre del encabezado HTTP que hay que comprobar. Se permiten expresiones de directiva. | Sí | N/D |
failed-check-httpcode | Código de estado HTTP que se devuelve si el encabezado no existe o tiene un valor no válido. Se permiten expresiones de directiva. | Sí | N/D |
failed-check-error-message | Mensaje de error que se devuelve en el cuerpo de la respuesta HTTP si el encabezado no existe o tiene un valor no válido. Los caracteres especiales de este mensaje deben incluir los caracteres de escape correctos. Se permiten expresiones de directiva. | Sí | N/D |
ignore-case | booleano. Si se establece en true , se omite la distinción entre mayúsculas y minúsculas cuando el valor del encabezado se compara con el conjunto de valores aceptables. Se permiten expresiones de directiva. |
Sí | N/D |
Elementos
Elemento | Descripción | Obligatorio |
---|---|---|
value | Agregue uno o varios de estos elementos para especificar los valores de encabezado HTTP permitidos. Cuando se especifican varios elementos value , el resultado de la comprobación se considera positivo en caso de coincidencia con cualquiera de los valores. |
No |
Uso
- Secciones de la directiva: inbound (entrada)
- Ámbitos de la directiva: global, producto, API y operación
- Puertas de enlace: clásica, v2, consumo, autohospedada y área de trabajo
Ejemplo
<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
<value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>
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