Paquetes de consultas en registros de Azure Monitor

Artigo
12/12/2023

Los paquetes de consultas actúan como contenedores para las consultas de registro de Azure Monitor. Permiten guardar consultas de registro y compartirlas en las áreas de trabajo y en otros contextos en Log Analytics.

Permisos

Puede establecer los permisos en un paquete de consultas cuando lo vea en Azure Portal. Necesita los siguientes permisos para usar paquetes de consultas:

Lector: los usuarios pueden ver y ejecutar todas las consultas del paquete de consultas.
Colaborador: los usuarios pueden modificar las consultas existentes y agregar nuevas al paquete de consultas.

Importante

Cuando un usuario necesite modificar o agregar consultas, conceda siempre al usuario el permiso Colaborador en DefaultQueryPack. De lo contrario, el usuario no podrá guardar ninguna consulta en la suscripción, ni siquiera en otros paquetes de consultas.

Visualización de paquetes de consultas

Puede ver y administrar los paquetes de consultas en Azure Portal desde el menú Paquetes de consultas de Log Analytics. Seleccione un paquete de consultas para ver y editar sus permisos. En este artículo, se describe cómo crear un paquete de consultas mediante la API.

Paquete de consultas predeterminado

Azure Monitor crea automáticamente un paquete de consultas denominado DefaultQueryPack en cada suscripción de un grupo de recursos llamado LogAnalyticsDefaultResources cuando guarda la primera consulta. Puede guardar consultas en este paquete de consultas o crear otros paquetes de consultas en función de sus requisitos.

Uso de varios paquetes de consultas

El paquete de consultas predeterminado es suficiente para que la mayoría de los usuarios guarde y reutilice las consultas. Es posible que desee crear varios paquetes de consultas para los usuarios de su organización si, por ejemplo, desea cargar diferentes conjuntos de consultas en diferentes sesiones de Log Analytics y proporcionar permisos diferentes para distintas colecciones de consultas.

Al crear un nuevo paquete de consultas, puede agregar etiquetas que clasifiquen las consultas según sus necesidades empresariales. Por ejemplo, podría etiquetar un paquete de consultas para relacionarlo con un departamento específico de la organización o con el nivel de gravedad de los problemas que las consultas incluidas deben solucionar. Al usar etiquetas, puede crear varios conjuntos de consultas destinados a varios conjuntos de usuarios y a distintas situaciones.

Para agregar paquetes de consultas al área de trabajo de Log Analytics:

Abra Log Analytics y seleccione Consultas en la esquina superior derecha.
En la esquina superior izquierda del cuadro de diálogo Consultas , junto a Paquetes de consultas, haga clic en Seleccionar paquetes de consulta o 0 seleccionados.
Seleccione los paquetes de consultas que desea agregar al área de trabajo.

Importante

Puede agregar hasta cinco paquetes de consultas a un área de trabajo de Log Analytics.

Creación de un paquete de consultas

Puede crear un paquete de consultas mediante la API de REST o en el panel Paquetes de consultas de Log Analytics en Azure Portal. Para abrir el panel Paquetes de consultas de Log Analytics en el portal, seleccione Todos los servicios>Otros.

Nota:

Las consultas guardadas en el paquete de consultas no se cifran con la clave administrada por el cliente. Seleccione Guardar como consulta heredada al guardar consultas en su lugar para protegerlos con clave administrada por el cliente.

Creación de un token

Debe tener un token para la autenticación de la solicitud de la API. Hay varios métodos para obtener un token. Un método consiste en usar armclient.

Primero, inicie sesión en Azure con el siguiente comando:

armclient login

A continuación, cree el token con el comando siguiente. El token se copia automáticamente en el Portapapeles, para que pueda pegarlo en otra herramienta.

armclient token

Creación de una carga

La carga de la solicitud es el objeto JSON que define una o varias consultas y la ubicación donde se debe almacenar el paquete de consultas. El nombre del paquete de consultas se especifica en la solicitud de API que se describe en la sección siguiente.

{
    "location": "eastus",
    "properties":
    {
        "displayName": "Query name that will be displayed in the UI",
        "description": "Query description that will be displayed in the UI",
        "body": "<<query text, standard KQL code>>",
        "related": {
            "categories": [
                "workloads"
            ],
            "resourceTypes": [
                "microsoft.insights/components"
            ],
            "solutions": [
                "logmanagement"
            ]
        },
        "tags": {
            "Tag1": [
                "Value1",
                "Value2"
            ]
        }
    }
}

Cada consulta del paquete de consultas tiene las siguientes propiedades:

Propiedad	Descripción
`displayName`	Nombre para mostrar que aparece en Log Analytics para cada consulta.
`description`	Descripción de la consulta que se muestra en Log Analytics para cada consulta.
`body`	Consulta escrita en el lenguaje de consulta Kusto.
`related`	Categorías relacionadas, tipos de recursos y soluciones para la consulta. Se usa para que el usuario agrupe y filtre en Log Analytics a fin de localizar su consulta. Cada consulta puede tener hasta 10 de cada tipo. Recupere los valores permitidos de https://api.loganalytics.io/v1/metadata?select=resourceTypes, solutions y categories.
`tags`	Otras etiquetas usadas por el usuario para ordenar y filtrar en Log Analytics. Cada etiqueta se agregará a Category, Resource Type y Solution al agrupar y filtrar consultas.

Creación de una solicitud

Use la siguiente solicitud para crear un paquete de consultas mediante la API de REST. La solicitud debe utilizar la autorización del token de portador. El tipo de contenido debe ser application/json.

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack?api-version=2019-09-01

Use una herramienta que pueda enviar una solicitud de la API de REST, como Fiddler o Postman, para enviar la solicitud mediante la carga descrita en la sección anterior. El identificador de consulta se generará y devolverá en la carga útil.

Actualización de un paquete de consultas

Para actualizar un paquete de consultas, envíe la siguiente solicitud con una carga actualizada. Este comando requiere el identificador del paquete de consultas.

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack/queries/query-id/?api-version=2019-09-01

Pasos siguientes

Consulte Uso de consultas en Azure Monitor Log Analytics para ver cómo interactúan los usuarios con los paquetes de consultas en Log Analytics.