Referencia de la directiva de API Management
En esta sección se proporcionan vínculos a artículos de referencia para todas las directivas de API Management.
Más información sobre las directivas:
Importante
Limitar la tasa de llamadas por suscripción y establecer la cuota de uso por suscripción tienen una dependencia de la clave de suscripción. No se requiere una clave de suscripción cuando se aplican otras directivas.
Directivas de restricción de acceso
- Activar encabezado HTTP: aplica la existencia o el valor de un encabezado HTTP.
- Obtener contexto de autorización: obtiene el contexto de autorización de una autorización especificada configurada en la instancia de API Management.
- Limitar la frecuencia de llamadas por suscripción : evita los picos de uso de la API limitando la frecuencia de llamadas, por suscripción.
- Limitar la frecuencia de llamadas por clave : evita los picos de uso de la API limitando la frecuencia de llamadas, por clave.
- Restringir IP de autor de llamada : filtra (permite/deniega) las llamadas de direcciones IP específicas o de intervalos de direcciones.
- Establecer cuota de uso por suscripción : le permite aplicar un volumen de llamadas renovables o permanentes o una cuota de ancho de banda por suscripción.
- Establecer cuota de uso por clave : le permite aplicar un volumen de llamadas renovables o permanentes o una cuota de ancho de banda por clave.
- Validar token de Azure Active Directory: confirma la existencia y validez de un JWT de Azure Active Directory extraído de un encabezado HTTP, un parámetro de consulta o un valor de token especificados.
- Validar JWT: confirma la existencia y validez de un JWT extraído de un encabezado HTTP, un parámetro de consulta o un valor de token especificados.
- Validar el certificado de cliente : exige que un certificado presentado por un cliente a una instancia de API Management coincida con notificaciones y reglas de validación especificadas.
Directivas avanzadas
- Flujo de control: aplica condicionalmente instrucciones de directiva basadas en los resultados de la evaluación de expresiones booleanas.
- Emisión de métricas: envía métricas personalizadas a Application Insights en ejecución.
- Reenviar solicitud : reenvía la solicitud al servicio back-end.
- Incluir fragmento: inserta un fragmento de la directiva en la definición de directiva.
- Limitar la simultaneidad: evita que las directivas delimitadas las ejecute simultáneamente un número de solicitudes mayor que el especificado.
- Registro en el centro de eventos: envía mensajes en el formato especificado a un centro de eventos definido por una entidad de registrador.
- Mock response (Simular respuesta): anula la ejecución de la canalización y devuelve la respuesta ficticia directamente al llamador.
- Reintentar : reintenta ejecutar las instrucciones de directiva adjuntas, si y hasta que se cumple la condición. La ejecución se repite en los intervalos de tiempo especificados y hasta el número de reintentos indicado.
- Devolver respuesta : anula la ejecución de la canalización y devuelve la respuesta especificada directamente al llamador.
- Enviar solicitud unidireccional : envía una solicitud a la dirección URL especificada sin esperar una respuesta.
- Enviar solicitud : envía una solicitud a la dirección URL especificada.
- Establecer el proxy HTTP: permite enrutar las solicitudes reenviadas a través de un proxy HTTP.
- Establecer método de solicitud : le permite cambiar el método HTTP de una solicitud.
- Establecimiento de código de estado: cambia el código de estado HTTP al valor especificado.
- Establecimiento de variable: conserva un valor en una variable context con nombre para su posterior acceso.
- Seguimiento: agrega seguimientos personalizados a la salida del seguimiento de solicitudes en la consola de prueba, a los datos de telemetría de Application Insights y a los registros de recursos.
- Wait (Esperar): espera a que se completen las directivas adjuntas Send request (Enviar solicitud), Get value from cache (Obtener el valor de caché) o Control flow (Flujo de control) antes de continuar.
Directivas de autenticación
- Autenticar con opción básica : autenticar con un servicio de back-end mediante la autenticación básica.
- Autenticar con certificado de cliente : autenticar con un servicio de back-end mediante certificados de cliente.
- Autenticar con identidad administrada: autenticar con un servicio de back-end mediante una identidad administrada.
Directivas de almacenamiento en caché
- Obtener de la caché: realiza una búsqueda en la caché y devuelve una respuesta en caché válida cuando esté disponible.
- Almacenar en caché : almacena en caché la respuesta de acuerdo con la configuración de control de caché especificada.
- Obtener valor de caché : recupere un elemento almacenado en caché por clave.
- Almacenar valor en caché : almacene un elemento en la memoria caché por clave.
- Quitar valor de caché ; quita un elemento de la memoria caché por clave.
Directivas entre dominios
- Permitir llamadas entre dominios : permite que la API sea accesible desde los clientes basados en explorador de Adobe Flash y Microsoft Silverlight.
- CORS : agrega soporte de uso compartido de recursos entre orígenes (CORS) a una operación o a una API para permitir llamadas entre dominios desde clientes basados en explorador.
- JSONP : agrega JSON con soporte de relleno (JSONP) a una operación o a una API para permitir llamadas entre dominios desde clientes basados en explorador de JavaScript.
Directivas de integración de Dapr
- Envío de una solicitud a un servicio: Utiliza el entorno de ejecución de Dapr para buscar un microservicio de Dapr y comunicarse con él con confianza. Para más información sobre la invocación de servicios en Dapr, consulte la descripción de este archivo README.
- Envío de un mensaje a un tema de publicación/suscripción: Utiliza el entorno de ejecución de Dapr para publicar un mensaje en un tema de publicación/suscripción. Para más información sobre la mensajería de publicación/suscripción de Dapr, consulte la descripción en este archivo README.
- Activación de un enlace de salida: Utiliza el entorno de ejecución de Dapr para invocar un sistema externo mediante un enlace de salida. Para más información sobre los enlaces de Dapr, consulte la descripción en este archivo README.
Directivas de GraphQL API
- Validar solicitud de GraphQL: valida y autoriza una solicitud a una API de GraphQL.
- Establecer resolución de GraphQL: recupera o establece datos de un campo de GraphQL en un tipo de objeto especificado en un esquema de GraphQL.
Directivas de transformación
- Convertir JSON a XML : convierte el cuerpo de solicitud o respuesta de JSON a XML.
- Convertir XML a JSON : convierte el cuerpo de solicitud o respuesta de XML a JSON.
- Buscar y reemplazar la cadena en el cuerpo : encuentra una subcadena de solicitud o de respuesta y la reemplaza por una subcadena diferente.
- Enmascarar direcciones URL en el contenido: reescribe (enmascara) los vínculos en el cuerpo de la respuesta para que apunten al vínculo equivalente mediante la puerta de enlace.
- Establecer el servicio back-end : cambia el servicio back-end para una solicitud entrante.
- Establecer cuerpo -establece el cuerpo del mensaje para las solicitudes entrantes y salientes.
- Establecer encabezado HTTP : asigna un valor a un encabezado de respuesta o de solicitud existente o agrega un nuevo encabezado de este tipo.
- Establecer el parámetro de cadena de consulta : agrega, reemplaza el valor o elimina el parámetro de la cadena de consulta de la solicitud.
- URL de reescritura : convierte una URL de solicitud de su forma pública a la forma esperada por el servicio web.
- Transformar XML mediante una XSLT: aplica una transformación de XSL al XML del cuerpo de la solicitud o respuesta.
Directivas de validación
- Validar contenido: valida el tamaño o el contenido del cuerpo de una solicitud o respuesta con uno o varios esquemas de API. Los formatos de esquema admitidos son JSON y XML.
- Validar parámetros: valida los parámetros del encabezado de solicitud, la consulta o la ruta de acceso con el esquema de la API.
- Validar encabezados: valida los encabezados de respuesta con el esquema de la API.
- Validar código de estado: valida los códigos de estado HTTP en
Pasos siguientes
Para más información sobre el trabajo con directivas, vea: