Referencia de la directiva de API Management

  • Artículo

SE APLICA A: todos los niveles de API Management

En esta sección se proporcionan descripciones breves y vínculos a artículos de referencia para todas las directivas de API Management. Se indican las puertas de enlace de API Management que admiten cada directiva. Para obtener información detallada sobre la configuración de directivas y ejemplos, consulte los artículos de referencia vinculados.

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.

Limitación de frecuencia y cuotas

Directiva Descripción Clásico V2 Consumo Autohospedado
Limitar la frecuencia de llamadas por suscripción Evita los picos de uso de la API al limitar la frecuencia de llamadas, por suscripción. Sí Sí Sí Sí
Limitar la frecuencia de llamadas por clave Evita los picos de uso de la API al limitar la frecuencia de llamadas, por clave. Sí Sí No Sí
Establecer cuota de uso por suscripción Permite aplicar un volumen de llamadas o una cuota de ancho de banda renovables o permanentes por suscripción. Sí Sí Sí Sí
Establecer cuota de uso por clave Permite aplicar un volumen de llamadas o una cuota de ancho de banda renovables o permanentes por clave. Sí No No Sí
Limitar la simultaneidad Evita que las directivas delimitadas las ejecute simultáneamente un número de solicitudes mayor que el especificado. Sí Sí Sí Sí

Autenticación y autorización

Directiva Descripción Clásico V2 Consumo Autohospedado
Activar encabezado HTTP Confirma la existencia y/o el valor de un encabezado HTTP. Sí Sí Sí Sí
Obtener un código de autorización Obtiene el contexto de autorización de una conexión especificada a un proveedor de credenciales configurado en la instancia de API Management. Sí Sí Sí No
Restringir IP de autor de llamada Filtra (permite o deniega) las llamadas de direcciones IP específicas y/o de intervalos de direcciones. Sí Sí Sí Sí
Validar token de Microsoft Entra Confirma la existencia y validez de un JWT de Microsoft Entra (anteriormente denominado Azure Active Directory) extraído de un encabezado HTTP, un parámetro de consulta o un valor de token especificados. Sí Sí Sí Sí
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. Sí Sí Sí Sí
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. Sí Sí Sí Sí
Autenticar con opción básica Se autentica con un servicio back-end mediante autenticación básica. Sí Sí Sí Sí
Autenticar con certificado de cliente Se autentica con un servicio back-end mediante certificados de cliente. Sí Sí Sí Sí
Autenticación con una identidad administrada Se autentica con un servicio back-end mediante una identidad administrada. Sí Sí Sí Sí

Validación del contenido

Directiva Descripción Clásico V2 Consumo Autohospedado
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. Sí Sí Sí Sí
Validación de la solicitud de GraphQL Valida y autoriza una solicitud a la GraphQL API. Sí Sí Sí Sí
Validar solicitud de OData Valida una solicitud a una API de OData para garantizar la conformidad con la especificación de OData. Sí Sí Sí Sí
Validar parámetros Valida los parámetros del encabezado de solicitud, la consulta o la ruta de acceso con el esquema de la API. Sí Sí Sí Sí
Validar encabezados Valida los encabezados de respuesta con el esquema de la API. Sí Sí Sí Sí
Validar código de estado Valida los códigos de estado HTTP en las respuestas con el esquema de la API. Sí Sí Sí Sí

Enrutamiento

Directiva Descripción Clásico V2 Consumo Autohospedado
Reenviar solicitud Reenvía la solicitud al servicio back-end. Sí Sí Sí Sí
Establecer el servicio back-end Cambia la dirección URL base del servicio back-end de una solicitud entrante a una dirección URL o a un back-end. Hacer referencia a un recurso de back-end permite administrar la dirección URL base del servicio de back-end y otras configuraciones en un solo lugar. Implemente también el equilibrio de carga del tráfico entre un grupo de servicios back-end y reglas de disyuntor para proteger el back-end de demasiadas solicitudes. Sí Sí Sí Sí
Establecer el proxy HTTP Permite enrutar las solicitudes reenviadas a través de un proxy HTTP. Sí Sí Sí Sí

Almacenamiento en memoria caché

Directiva Descripción Clásico V2 Consumo Autohospedado
Obtener de caché Realiza la búsqueda de caché y devuelve una respuesta almacenada en caché válida cuando está disponible. Sí Sí Sí Sí
Almacenar en caché Almacena en caché la respuesta en función de la configuración de control de caché especificada. Sí Sí Sí Sí
Obtener valor de la caché Recupera un elemento almacenado en caché por clave. Sí Sí Sí Sí
Almacenar valor en la caché Almacena un elemento en la memoria caché por clave. Sí Sí Sí Sí
Quitar valor de la caché Quita un elemento de la memoria caché por clave. Sí Sí Sí Sí

Transformación

Directiva Descripción Clásico V2 Consumo Autohospedado
Establecer método de solicitud Permite cambiar el método HTTP de una solicitud. Sí Sí Sí Sí
Establecer código de estado Cambia el código de estado HTTP al valor especificado. Sí Sí Sí Sí
Establecimiento de la variable Conserva un valor en una variable de contexto con nombre para acceder a él posteriormente. Sí Sí Sí Sí
Establecer cuerpo Establece el cuerpo del mensaje para una solicitud o respuesta. Sí Sí Sí Sí
Establecer encabezado HTTP Asigna un valor a un encabezado de respuesta y/o de solicitud existente o agrega un nuevo encabezado de este tipo. Sí Sí Sí Sí
Establecer el parámetro de cadena de consulta Agrega, reemplaza el valor del parámetro de cadena de consulta de solicitud o elimina este parámetro. Sí Sí Sí Sí
URL de reescritura Convierte una URL de solicitud de su forma pública a la forma esperada por el servicio web. Sí Sí Sí Sí
Convertir JSON a XML Convierte el cuerpo de solicitud o de respuesta de JSON a XML. Sí Sí Sí Sí
Convertir XML a JSON Convierte el cuerpo de solicitud o de respuesta de XML a JSON. Sí Sí Sí Sí
Buscar y reemplazar la cadena en el cuerpo Busca una subcadena de solicitud o de respuesta y la sustituye por otra distinta. Sí Sí Sí Sí
Enmascarar URL en el contenido Reescribe (enmascara) los vínculos del cuerpo de la respuesta para que apunten al vinculo equivalente mediante la puerta de enlace. Sí Sí Sí Sí
Transformar XML mediante una XSLT Aplica una transformación XSL al XML del cuerpo de la solicitud o la respuesta. Sí Sí Sí Sí
Return response Anula la ejecución de la canalización y devuelve la respuesta especificada directamente al autor de llamada. Sí Sí Sí Sí
Simular respuesta Anula la ejecución de la canalización y devuelve la respuesta ficticia directamente al autor de llamada. Sí Sí Sí Sí

Entre dominios

Directiva Descripción Clásico V2 Consumo Autohospedado
Permitir llamadas entre dominios Hace que la API sea accesible desde clientes basados en exploradores de Adobe Flash y Microsoft Silverlight. Sí Sí Sí Sí
CORS Agrega soporte de uso compartido de recursos entre orígenes (CORS) a una operación o una API para permitir llamadas entre dominios desde clientes basados en exploradores. Sí Sí Sí Sí
JSONP Agrega soporte de JSON con relleno (JSONP) a una operación o una API para permitir llamadas entre dominios desde clientes basados en exploradores de JavaScript. Sí Sí Sí Sí

Integración y comunicación externa

Directiva Descripción Clásico V2 Consumo Autohospedado
Enviar solicitud Envía una solicitud a la dirección URL especificada. Sí Sí Sí Sí
Enviar solicitud unidireccional Envía una solicitud a la dirección URL especificada sin esperar una respuesta. Sí Sí Sí Sí
Registro en el centro de eventos Envía mensajes en el formato especificado a un centro de eventos definido por una entidad del registrador. Sí Sí Sí Sí
Enviar solicitud a un servicio (Dapr) 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. No N.º No Sí
Enviar mensaje a un tema de publicación/suscripción (Dapr) 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. No N.º No Sí
Activación de un enlace de salida (Dapr) 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. No N.º No Sí

Registro

Directiva Descripción Clásico V2 Consumo Autohospedado
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. Sí Sí1 Sí Sí
Emisión de métricas Envía métricas personalizadas a Application Insights en ejecución. Sí Sí Sí Sí

1 En la puerta de enlace V2, la directiva trace no agrega actualmente la salida de seguimiento en la consola de prueba.

Solucionadores de GraphQL

Directiva Descripción Clásico V2 Consumo Autohospedado
Origen de datos de Azure SQL para una resolución Configura la solicitud Azure SQL y la respuesta opcional para resolver los datos de un tipo de objeto y un campo en un esquema GraphQL. Sí Sí No No
Origen de datos de Cosmos DB para una resolución Configura la solicitud de Cosmos DB y la respuesta opcional para resolver los datos de un tipo de objeto y un campo en un esquema GraphQL. Sí Sí No No
Origen de datos HTTP para una resolución Configura la solicitud HTTP y, opcionalmente, la respuesta HTTP para resolver los datos de un tipo de objeto y un campo en un esquema GraphQL. Sí Sí Sí No
Publicación de eventos en una suscripción de GraphQL Publica un evento en una o varias suscripciones especificadas en el esquema de GraphQL API. Configure la directiva en un solucionador de GraphQL para un campo relacionado en el esquema para otro tipo de operación, como una mutación. Sí Sí Sí No

Control y flujo de directivas

Directiva Descripción Clásico V2 Consumo Autohospedado
Flujo de control Aplica condicionalmente las instrucciones de directivas basadas en los resultados de la evaluación de expresiones booleanas. Sí Sí Sí Sí
Incluir fragmento Inserta un fragmento de la directiva en la definición de directiva. Sí Sí Sí Sí
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. Sí Sí Sí Sí
Espera Espera a que se completen las directivas adjuntas Enviar solicitud, Obtener el valor de caché o Flujo de control antes de continuar. Sí Sí Sí Sí

Contenido relacionado

Para más información sobre el trabajo con directivas, vea: