Пакеты запросов в журналах Azure Monitor

Статья
12/12/2023

Пакеты запросов служат контейнерами для запросов журналов в Azure Monitor. Они позволяют сохранять запросы журналов и совместно использовать их в рабочих областях и других контекстах в Log Analytics.

Разрешения

Разрешения для пакета запроса можно задать при просмотре на портале Azure. Для использования пакетов запросов требуются следующие разрешения:

Читатель: пользователи могут просматривать и запускать все запросы в пакете запросов.
Участник. Пользователи могут изменять существующие запросы и добавлять новые запросы в пакет запросов.

Важно!

Когда пользователю необходимо изменить или добавить запросы, всегда предоставьте пользователю разрешение участника на этот DefaultQueryPackпараметр. В противном случае пользователь не сможет сохранять запросы к подписке, в том числе в других пакетах запросов.

Просмотр пакетов запросов

Вы можете просматривать пакеты запросов и управлять ими в меню Log Analytics query packs (Пакеты запросов Log Analytics) портала Azure. Выберите пакет запросов, чтобы просмотреть и изменить его разрешения. В этой статье описывается, как создать пакет запросов с помощью API.

Пакет запросов по умолчанию

Azure Monitor автоматически создает пакет запросов, который вызывается DefaultQueryPack в каждой подписке в группе ресурсов, вызываемой LogAnalyticsDefaultResources при сохранении первого запроса. Запросы можно сохранить в этом пакете запросов или создать другие пакеты запросов в зависимости от ваших требований.

Использование нескольких пакетов запросов

Пакет запросов по умолчанию достаточно для большинства пользователей для сохранения и повторного использования запросов. Возможно, потребуется создать несколько пакетов запросов для пользователей в организации, если, например, вы хотите загрузить различные наборы запросов в разных сеансах Log Analytics и предоставить различные разрешения для различных коллекций запросов.

При создании нового пакета запросов можно добавить теги, которые классифицируют запросы на основе бизнес-потребностей. Например, можно отметить пакет запросов тегом, чтобы связать его с определенным подразделением в организации или с уровнем серьезности проблем, для устранения которых используются соответствующие запросы. С помощью тегов можно создавать различные наборы запросов, предназначенных для различных наборов пользователей и различных ситуаций.

Чтобы добавить пакеты запросов в рабочую область Log Analytics, выполните следующие действия.

Откройте Log Analytics и выберите "Запросы " в правом верхнем углу.
В левом верхнем углу диалогового окна "Запросы" рядом с пакетами запросов щелкните "Выбрать пакеты запросов" или "0".
Выберите пакеты запросов, которые необходимо добавить в рабочую область.

Важно!

В рабочую область Log Analytics можно добавить до пяти пакетов запросов.

Создание пакета запросов

Пакет запросов можно создать с помощью REST API или из области пакетов запросов Log Analytics в портал Azure. Чтобы открыть панель пакетов запросов Log Analytics на портале, выберите все службы>"Другие".

Примечание.

Запросы, сохраненные в пакете запросов, не шифруются с помощью ключа, управляемого клиентом. Выберите " Сохранить как устаревший запрос " при сохранении запросов, чтобы защитить их с помощью ключа, управляемого клиентом.

Создание маркера.

Необходимо иметь маркер для проверки подлинности запроса API. Существует несколько методов для получения маркера. Один из методов — использовать armclient.

Сначала войдите в Azure с помощью следующей команды:

armclient login

Затем создайте маркер с помощью следующей команды. Маркер автоматически копируется в буфер обмена, чтобы его можно было вставить в другое средство.

armclient token

Создание полезных данных

Полезные данные запроса — это JSON, определяющий один или несколько запросов и расположение, в котором должен храниться пакет запросов. Имя пакета запроса указывается в запросе API, описанном в следующем разделе.

{
    "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"
            ]
        }
    }
}

Каждый запрос в пакете запросов имеет следующие свойства:

Свойство	Description
`displayName`	Отображаемое имя, указываемое в Log Analytics для каждого запроса.
`description`	Описание запроса, отображаемое в Log Analytics для каждого запроса.
`body`	Запрос, написанный язык запросов Kusto.
`related`	Связанные категории, типы ресурсов и решения для запроса. Используется пользователем для группирования и фильтрации в Log Analytics с целью поиска запроса. Каждый запрос может содержать до 10 типов. Получение допустимых значений из https://api.loganalytics.io/v1/metadata?select=resourceTypes, решений и категорий.
`tags`	Другие теги, используемые пользователем для сортировки и фильтрации в Log Analytics. Каждый тег будет добавлен в категорию, тип ресурса и решение при группировке и фильтрации запросов.

Создание запроса

Используйте следующий запрос, чтобы создать новый пакет запросов с помощью REST API. Запрос должен использовать авторизацию маркера-носителя. Тип контента должен быть 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

Используйте средство, которое может отправить запрос REST API, например Fiddler или Postman, для отправки запроса с помощью полезных данных, описанных в предыдущем разделе. Идентификатор запроса будет сформирован и возвращен в полезных данных.

Обновление пакета запросов

Чтобы обновить пакет запросов, отправьте следующий запрос с обновленными полезными данными. Для этой команды требуется идентификатор пакета запросов.

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

Следующие шаги

Изучите статью Использование запросов в Azure Monitor Log Analytics, чтобы узнать, как пользователи взаимодействуют с пакетами запросов в Log Analytics.