Настройка журналов диагностики с помощью REST API Azure Monitor

В этой статье описывается настройка журналов диагностики для фабрики данных Azure с помощью REST API Azure Monitor.

Параметры диагностики

Используйте параметры диагностики для настройки журналов диагностики для некомпьютерных ресурсов. Параметры элемента управления ресурсами имеют следующие функции:

• Они указывают, где отправляются журналы диагностики. Примеры включают учетную запись хранения Azure, концентратор событий Azure или журналы мониторинга.
• Они указывают, какие категории журналов отправляются.
• Они указывают, сколько времени должна храниться каждая категория журнала в учетной записи хранения.
• Срок хранения, равный нулевым дням, означает, что журналы хранятся навсегда. В противном случае значение может быть любым числом дней от 1 до 2 147 483 647.
• Если политики хранения заданы, но хранение журналов в учетной записи хранения отключено, политики хранения не влияют. Например, это условие может произойти, если выбраны только центры событий или параметры журналов мониторинга.
• Политики хранения применяются ежедневно. Граница между днями происходит в полночь по всемирному координированному времени (UTC). В конце дня журналы из дней, выходящих за рамки политики хранения, удаляются. Например, если у вас есть политика хранения в один день, то в начале сегодняшнего дня удаляются журналы, датированные ранее вчерашнего.

Включение журналов диагностики с помощью REST API монитора

Используйте REST API монитора для включения журналов диагностики.

Создание или обновление параметра диагностики в REST API монитора

Просьба

PUT
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Заголовки

• Замените {api-version} на 2016-09-01.
• Замените {resource-id} идентификатором ресурса, для которого необходимо изменить параметры диагностики. Дополнительные сведения см. в статье Использование групп ресурсов для управления ресурсами Azure.
• Задайте для заголовка Content-Type значение application/json.
• Задайте заголовок авторизации для веб-маркера JSON, полученного из идентификатора Microsoft Entra. Дополнительные сведения см. в разделе "Проверка подлинности запросов".

Тело

{
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "metrics": [
        ],
        "logs": [
                {
                    "category": "PipelineRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "TriggerRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                },
                {
                    "category": "ActivityRuns",
                    "enabled": true,
                    "retentionPolicy": {
                        "enabled": false,
                        "days": 0
                    }
                }
            ]
    },
    "location": ""
}

Недвижимость	Тип	Описание
storageAccountId	Струна	Идентификатор ресурса учетной записи хранения, в которую требуется отправить журналы диагностики.
serviceBusRuleId	Струна	Идентификатор правила служебной шины пространства имен, в котором вы хотите создать центры событий для потоковой передачи журналов диагностики. Идентификатор правила имеет формат {service bus resource ID}/authorizationrules/{key name}.
WorkspaceId	Струна	Идентификатор рабочей области, в которой будут сохранены журналы.
Метрики	Значения параметров запуска конвейера, передаваемые в вызываемый конвейер	Объект JSON, сопоставляющий имена параметров со значениями аргументов.
журналов	Сложный тип	Имя категории журнала диагностики для типа ресурса. Чтобы получить список категорий журналов диагностики для ресурса, выполните операцию параметров диагностики GET.
категория	Струна	Массив категорий журналов и их политик хранения.
timeGrain	Струна	Степень детализации метрик, которые фиксируются в формате продолжительности ISO 8601. Значение свойства должно быть PT1M, указывающее одну минуту.
включена	булевый	Указывает, включен ли сбор метрик или категорий журналов для этого ресурса.
политика хранения	Сложный тип	Описывает политику хранения для метрики или категории журналов. Это свойство используется только для учетных записей хранения.
дни	int	Количество дней для хранения метрик или журналов. Если значение свойства равно 0, журналы хранятся навсегда. Это свойство используется только для учетных записей хранения.

Ответ

200 ОК.

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

Получение сведений о параметрах диагностики в REST API монитора

Просьба

GET
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}

Заголовки

• Замените {api-version} на 2016-09-01.
• Замените {resource-id} идентификатором ресурса, для которого необходимо изменить параметры диагностики. Дополнительные сведения см. в статье Использование групп ресурсов для управления вашими ресурсами Azure.
• Задайте для заголовка Content-Type значение application/json.
• Задайте для заголовка авторизации веб-маркер JSON, полученный из идентификатора Microsoft Entra. Дополнительные сведения см. в разделе "Проверка подлинности запросов".

Ответ

200 OK.

{
    "id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
    "type": null,
    "name": "service",
    "location": null,
    "kind": null,
    "tags": null,
    "properties": {
        "storageAccountId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.Storage/storageAccounts/azmonlogs",
        "serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.EventHub/namespaces/shloeventhub/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "/subscriptions/<subID>/resourceGroups/ADF/providers/Microsoft.OperationalInsights/workspaces/mihaipie",
        "eventHubAuthorizationRuleId": null,
        "eventHubName": null,
        "metrics": [],
        "logs": [
            {
                "category": "PipelineRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "TriggerRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            },
            {
                "category": "ActivityRuns",
                "enabled": true,
                "retentionPolicy": {
                    "enabled": false,
                    "days": 0
                }
            }
        ]
    },
    "identity": null
}

Дополнительные сведения см. в статье о параметрах диагностики.

Связанный контент

Мониторинг операций служб SSIS с помощью Azure Monitor