Variables de entorno aplicables a Azure API Management Service
Comprender las variables de entorno aplicables a Azure API Management Service.
API Management ServiceAzure Las configuraciones le permiten especificar AzureAPI Management Service las configuraciones necesarias para Azure la conectividad.
Nota: Las siguientes propiedades se aplican a los modos de despliegue sprint boot y Azure Functions, a menos que se especifique lo contrario.
| Propiedades | Descripción |
|---|---|
| AZURE_ID_DE_SUSCRIPCIÓN | Obligatorio. El identificador de suscripción con el que se crea su servicio Azure API Management. Para obtener más información sobre cómo encontrar el ID de suscripción de su servicio Azure API Management, consulte la documentación de Azure. |
| GRUPO_DE_RECURSOS_AZURE | Obligatorio. El contenedor en el que se despliegan los recursos Azure API Management y managed.For detalles sobre cómo encontrar el grupo de recursos en el que se despliegan sus Azure API Management recursos, consulte la documentación Azure. |
| AZURE_TENANT_ID | Obligatorio. Azure iD de cuenta o ID de organización. Para obtener más información sobre cómo encontrar el ID de inquilino de su Azure cuenta, consulte Azure la documentación. |
| AZURE_CLIENT_ID | Obligatorio. ID de cliente para autorizar la conexión a Azure SDK. El ID de cliente se genera cuando se asigna el principio del servicio al Azure API Management Service. Para asignar el principio de servicio, utilice el portal Azure o la CLI Azure. Para obtener más información, consulte Uso de Azure Portal, Uso de Azure CLI. |
| AZURE_CLIENT_SECRET | Obligatorio. Secreto del cliente para autorizar la conexión a Azure SDK. El secreto del cliente se genera cuando se asigna el principio del servicio al Azure API Management Service. Para asignar el principio de servicio, utilice el portal Azure o la CLI Azure. Para obtener más información, consulte Uso de Azure Portal, Uso de Azure CLI. |
| AZURE_API_MANAGEMENT_SERVICE_NAME | Obligatorio. Un nombre único que identifica su instancia de Azure API Management. El nombre del recurso que se especifica al crear una instancia de Azure API Management Service es AZURE_API_MANAGEMENT_SERVICE_NAME. Para más detalles, consulte la documentación de Azure. Nota: AZURE_API_MANAGEMENT_SERVICE_NAME se considera un nombre de tiempo de ejecución en la administración de API federada.
|
| AZURE_MERTICS_SYNC_BUFFER_INTERVAL_MINUTES | Opcional. Mientras se recuperan las métricas mediante el SDK Azure, los datos analíticos (métricas) en tiempo real de Azure API Management Service pueden sufrir un retraso de 15 minutos o más, en función de la carga actual del servicio. Para más detalles, consulte la documentación de Azure. Por lo tanto, ajuste AZURE_MERTICS_SYNC_BUFFER_INTERVAL_MINUTES a más de 15 minutos. El valor por defecto es 15 minutes.If si no especifica un valor para esta propiedad, se considerará el valor por defecto. Especificar un valor inferior a 15 minutos da lugar a llamadas innecesarias, ya que es posible que los datos analíticos no estén disponibles. |
| MÉTRICAS DE AZURE POR SOLICITUDES O INFORMACIÓN | Opcional. Método en el que se recuperan las métricas de Azure SDK.
Peticiones : El agente utiliza el método reports( ).listByRequest para recuperar todas las peticiones en el intervalo de tiempo especificado. El agente crea métricas compatibles con la gestión de API federada, como transactionsCount, averageLatency, y averageResponseTime, las categoriza según el código de estado 2xx, 3xx, 4xx y 5xx antes de enviarlas a la gestión de API federada. Información : El agente utiliza el método ).listByApi reports( ).listByTime o reports( para recuperar el informe de datos métricos agregados en intervalos de 15 minutos (15, 30, 45). Sin embargo, este método no clasifica los datos según los códigos de estado. El valor predeterminado es Solicitudes. Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
Las configuraciones de administración de API federadas le permiten especificar los detalles de administración de API federadas con los que el servicio Azure API Management Service debe establecer la conectividad.
Nota: Las siguientes propiedades se aplican a los modos de despliegue Sprint boot y Azure Functions, a menos que se especifique lo contrario.
| Propiedades | Descripción |
|---|---|
| APICP_URL | Obligatorio. El URL válido que se utiliza para acceder a la gestión de API federada. Ejemplo: https://localhost:8080 |
| APICP_NOMBRE_DE_USUARIO | Obligatorio. Nombre de usuario que se utiliza para iniciar sesión en la gestión de API federada. |
| APICP_CONTRASEÑA | Obligatorio. Contraseña del nombre de usuario correspondiente, que se utiliza para iniciar sesión en la gestión de API federada mediante autenticación básica. |
| APICP_TOKEN | Opcional. Un token válido que se utiliza para autorizar la aplicación de gestión de API federada. Esta propiedad representa la autorización basada en token. Nota: Utilice la autorización básica (APICP_PASSWORD) o la autorización basada en token (APICP_TOKEN) para autorizar la aplicación de gestión de API federada.
|
| APICP_SSL_HABILITADO | Opcional. La certificación SSL de la gestión de API federadas. Valores posibles: true o false |
| APICP_TRUSTSTORE_PATH | Opcional. Ubicación del archivo truststore. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| Contraseña del almacén de certificados APICP | Opcional. Contraseña para acceder al archivo truststore. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| TIPO DE ALMACÉN DE CERTIFICADOS DE CONFIANZA APICP | Opcional. Tipo de almacén de confianza. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| APICP_KEYSTORE_PATH | Opcional. Ubicación del archivo keystore. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| Contraseña del almacén de claves APICP | Opcional. Contraseña para acceder al archivo keystore. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| TIPO_DE_ALMACÉN_DE_CLAVES_APICP | Opcional. Tipo de almacén de claves. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| APICP_KEY_ALIAS | Opcional. Alias de la clave en el almacén de claves. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| Clave_contraseña_APICP | Opcional. Contraseña de la clave en el almacén de claves. Si la propiedad APICP_SSL_ENABLED está establecida a true, debe especificar un valor para esta propiedad. |
| APICP_RUNTIME_NAME | Obligatorio. Nombre del tiempo de ejecución. La propiedad define cómo desea identificar el tiempo de ejecución en la gestión de API federada. El nombre no debe superar los 50 caracteres. De forma predeterminada, AZURE_API_MANAGEMENT_SERVICE_NAME se considera un nombre de tiempo de ejecución. |
| APICP_DESCRIPCIÓN_DE_TIEMPO_DE_EJECUCIÓN | Opcional. La descripción del tiempo de ejecución. La descripción no debe superar los 300 caracteres. Valor predeterminado: Azure Tiempo de ejecución. Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_UBICACIÓN_DE_TIEMPO_DE_EJECUCIÓN | Opcional. Ubicación donde se implementa el tiempo de ejecución. Especifique la ubicación en el formato País|Estado|Ciudad. Nota: Si se proporcionan tanto
APICP_RUNTIME_LOCATION como los campos individuales (APICP_RUNTIME_COUNTRY, APICP_RUNTIME_STATE, y APICP_RUNTIME_CITY), el valor de APICP_RUNTIME_LOCATION tiene prioridad. |
| APICP_PAÍS_DE_EJECUCIÓN | Opcional. País en el que se implementa el tiempo de ejecución. |
| APICP_ESTADO_DE_EJECUCIÓN | Opcional. Indique el estado en el que se implementa el tiempo de ejecución. |
| APICP_RUNTIME_CIUDAD | Opcional. Ciudad donde se implementa el tiempo de ejecución. Si el nombre de la ciudad es único y no se especifican los campos de país y estado, la gestión de API federada rellena automáticamente los valores de país y estado. |
| APICP_RUNTIME_REGION | Opcional. El nombre de la región donde se aloja el tiempo de ejecución. Ejemplo: ESTE DE EE. UU. El nombre de la región no debe superar los 50 caracteres. |
| APICP_ETIQUETAS_DE_TIEMPO_DE_EJECUCIÓN | Opcional. El nombre de la etiqueta del tiempo de ejecución. Predeterminado: AWS Si no se especifica un valor para esta propiedad, se considera el valor predeterminado. Las etiquetas se utilizan para organizar y clasificar los tiempos de ejecución. Se pueden especificar varias etiquetas añadiendo comas. Ejemplo: prueba, local, no devTags debe superar los 50 caracteres. No debe contener espacios en blanco y el número de etiquetas no debe superar las 100. |
| APICP_HTTP_CONEXIÓN_TIEMPO_LÍMITE | Opcional. La duración en segundos en la que el agente debe establecer la conexión inicial con la gestión de API federada. Valor predeterminado: 10 segundos. |
| APICP_HTTP_READ_TIMEOUT | Opcional. La duración en segundos durante la cual el agente no recibe datos a través de una conexión HTTP establecida. Valor predeterminado: 10 segundos. |
| APICP_HTTP_MAX_CONEXIONES | Opcional. Define el número máximo de conexiones simultáneas que el agente puede establecer con la gestión de API federada. Predeterminado: 5. |
| APICP_HTTP_NÚMERO_MÁXIMO_DE_REINTENTOS | Opcional. Define el número máximo de veces que se reintentará automáticamente una operación tras un fallo inicial de conexión. Predeterminado: 0. |
| APICP_HTTP_RETRY_INTERVAL | Opcional. Especifica el número de segundos que el agente espera antes de intentar volver a conectarse a la gestión de API federada tras un fallo en la conexión. Predeterminado: 5 segundos |
Las configuraciones de agente le permiten especificar las configuraciones del agente, como el intervalo de latido, el intervalo de sincronización de activos y el intervalo de sincronización de métricas.
Las configuraciones del Agente difieren entre los modos de despliegue Sprint boot y Azure Functions.
Configuraciones de agente para el modo de despliegue de arranque Sprint:
| Propiedades | Descripción | Valores posibles |
|---|---|---|
| APICP_HEARTBEAT_SEND_INTERVAL_SECONDS | Opcional. La duración en segundos en la que el agente debe enviar el estado de comprobación de salud (heartbeats) de la Azure API Management Service a la gestión de API federada. | Mín: 15 segundos Máximo: 900 segundos (5 minutos) Por defecto: 60 segundos. Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_PUBLICAR_ACTIVOS | Opcional. Activar o desactivar la publicación de activos (APIs) en la gestión federada de APIs. |
|
| APICP_ENVIAR_MÉTRICAS | Opcional. Active o desactive la sincronización de los datos analíticos (métricas) de Azure con la gestión de API federada. |
|
| APICP_MÉTRICAS_INTERVALO_DE_ENVÍO_SEGUNDOS | Opcional. La duración en segundos en la que el agente debe recuperar las métricas de Azure API Management Service utilizando Azure SDK y enviar las métricas a la gestión de API federada. | Mín: 60 segundos Máx: 7200 segundos Predeterminado: 300 segundos Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_ACTIVOS_SINCRONIZACIÓN_INTERVALO_SEGUNDOS | Opcional. La duración en segundos en la que el agente debe sincronizar los cambios realizados en los activos desde Azure API Management Service con la gestión de API federada mediante el SDK Azure. | Mín: 60 segundos (valor por defecto) Máx: 21600 segundos (6 horas). Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_SINCRONIZACIÓN_ACTIVOS | Opcional. Activar o desactivar la sincronización de activos (APIs) con la gestión federada de APIs. |
|
| APICP_CAPACIDAD_DE_TIEMPO_DE_EJECUCIÓN_VALOR | Opcional. La estimación aproximada del rendimiento que un tiempo de ejecución puede manejar durante la duración especificada. | Valor por defecto: 500000.If si no especifica un valor para esta propiedad, se considerará el valor por defecto. |
| APICP_CAPACIDAD_DE_TIEMPO_DE_EJECUCIÓN_UNIDAD | Opcional. Elija la unidad de duración en la que debe definirse la capacidad. | Los valores posibles son los siguientes:
|
| NIVEL_DE_REGISTRO_APICP | Opcional. El nivel de registros a capturar. |
|
Configuraciones de agente para el modo de despliegue Funciones:
| Propiedades | Descripción | Valores posibles |
|---|---|---|
| APICP_SYNC_HEARTBEAT_INTERVAL_CRON | Obligatorio. La duración en segundos en la que el agente debe enviar el estado de comprobación de salud (heartbeats) de la Azure API Management Service a la gestión de API federada. | Especifique el valor como una expresión cron. Mín: 0 */1 * * * (Equivalente a 60 segundos) Máx: 0 */5 * * * (Equivalente a 900 segundos) |
| APICP_HEARTBEAT_SEND_INTERVAL_SECONDS | Obligatorio. La duración en segundos en la que el agente debe enviar el estado de comprobación de salud (heartbeats) de la Azure API Management Service a la gestión de API federada. Este valor se utiliza para mostrar información en la interfaz de usuario de gestión de la API federada. | Mín: 15 segundos Máximo: 900 segundos (15 minutos). Predeterminado: 60 segundos Si no especifica un valor para esta propiedad, se considera el valor por defecto. Asegúrese de especificar un valor en segundos que coincida con la expresión cron especificada en APICP_SYNC_HEARTBEAT_INTERVAL_CRON Por ejemplo: Si APICP_SYNC_HEARTBEAT_INTERVAL_CRON está ajustado a 0 */1 * * * * entonces ajuste APICP_HEARTBEAT_SEND_INTERVAL_SECONDS a 60 segundos |
| APICP_SINCRONIZACIÓN_MÉTRICAS_INTERVALO_CRON | Obligatorio. La duración en segundos en la que el agente debe recuperar las métricas de Azure API Management Service utilizando Azure SDK y enviar las métricas a la gestión de API federada. | Especifique el valor como una expresión cron. Mín: 0 */1 * * * (Equivalente a 60 segundos) Máx: 0 0 */2 * * *(Equivalente a 7200 segundos) |
| APICP_MÉTRICAS_INTERVALO_DE_ENVÍO_SEGUNDOS | Obligatorio. La duración en segundos en la que el agente debe recuperar las métricas de Azure API Management Service utilizando Azure SDK y enviar las métricas a la gestión de API federada. Este valor se utiliza para mostrar información en la interfaz de usuario de gestión de la API federada. | Mín: 60 segundos Máx: 7200 segundos Por defecto: 300 segundos. Si no especifica un valor para esta propiedad, se considera el valor por defecto. Asegúrese de especificar un valor en segundos que coincida con la expresión cron especificada en APICP_SYNC_METRICS_INTERVAL_CRON Por ejemplo: Si APICP_SYNC_METRICS_INTERVAL_CRON se establece en 0 */2 * * * * entonces establezca APICP_METRICS_SEND_INTERVAL_SECONDS en 120 segundos. |
| APICP_ACTIVOS_SINCRONIZACIÓN_INTERVALO_SEGUNDOS | Opcional. La duración en segundos en la que el Agente debe sincronizar los cambios realizados en los activos desde Azure API Management Service a la gestión de API federada mediante el SDK Azure. | Mín: 60 segundos (valor por defecto) Máx: 21600 segundos (6 horas). Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_SINCRONIZACIÓN_ACTIVOS | Opcional. Activar o desactivar la sincronización de activos (APIs) con la gestión federada de APIs. |
|
| APICP_CAPACIDAD_DE_TIEMPO_DE_EJECUCIÓN_VALOR | Opcional. La estimación aproximada del rendimiento que un tiempo de ejecución puede manejar durante la duración especificada. | Valor por defecto: 500000 Si no especifica un valor para esta propiedad, se considera el valor por defecto. |
| APICP_CAPACIDAD_DE_TIEMPO_DE_EJECUCIÓN_UNIDAD | Opcional. Elija la unidad de duración en la que debe definirse la capacidad. | Los valores posibles son los siguientes:
|
| NIVEL_DE_REGISTRO_APICP | Opcional. El nivel de registros a capturar. |
|