Nastavení diagnostických protokolů prostřednictvím rozhraní REST API služby Azure Monitor

Tento článek popisuje, jak nastavit diagnostické protokoly pro Azure Data Factory pomocí rozhraní REST API služby Azure Monitor.

Nastavení diagnostiky

Nastavení diagnostiky použijte ke konfiguraci diagnostických protokolů pro prostředky jiné než výpočetní. Nastavení pro řízení prostředků mají následující funkce:

  • Určují, kam se odesílají diagnostické protokoly. Mezi příklady patří účet úložiště Azure, centrum událostí Azure nebo protokoly monitorování.
  • Určují, které kategorie protokolů se odesílají.
  • Určují, jak dlouho se mají jednotlivé kategorie protokolů uchovávat v účtu úložiště.
  • Uchovávání nulových dnů znamená, že se protokoly uchovávají navždy. Jinak může být hodnota libovolný počet dní od 1 do 2 147 483 647.
  • Pokud jsou nastavené zásady uchovávání informací, ale ukládání protokolů do účtu úložiště je zakázané, zásady uchovávání informací nemají žádný vliv. K této podmínce může dojít například v případě, že jsou vybrány pouze centra událostí nebo možnosti Monitorovat protokoly.
  • Zásady uchovávání informací se použijí denně. Hranice mezi dny probíhá o půlnoci koordinovaného univerzálního času (UTC). Na konci dne se odstraní protokoly z dnů, které jsou nad rámec zásad uchovávání informací. Pokud máte například zásady uchovávání informací o jednom dni, na začátku dnešního dne se odstraní protokoly před včerejším dnem.

Povolte diagnostické protokoly prostřednictvím REST API Monitoringu

K povolení diagnostických protokolů použijte monitorovací rozhraní REST API.

Vytvoření nebo aktualizace nastavení diagnostiky v rozhraní REST API pro monitorování

Žádost

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

Hlavičky

  • Nahraďte {api-version} s 2016-09-01.
  • Nahraďte {resource-id} ID prostředku, pro který chcete upravit nastavení diagnostiky. Další informace najdete v článku Použití skupin prostředků ke správě prostředků Azure.
  • Nastavte záhlaví Content-Type na application/json.
  • Nastavte autorizační hlavičku na webový token JSON, který jste získali z ID Microsoft Entra. Další informace najdete v tématu Ověřování požadavků.

Tělo

{
    "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": ""
}
Vlastnictví Typ Popis
storageAccountId Řetězec ID prostředku účtu úložiště, kam chcete odesílat diagnostické protokoly.
serviceBusRuleId Řetězec ID pravidla služby Service-Bus pro obor názvů, kde chcete vytvořit centra událostí pro streamování protokolů diagnostiky. ID pravidla má formát {service bus resource ID}/authorizationrules/{key name}.
workspaceId Řetězec Identifikátor pracovního prostoru, do kterého se protokoly uloží.
metriky Hodnoty parametrů běhu kanálu, které se mají předat do vyvolaného kanálu Objekt JSON, který mapuje názvy parametrů na hodnoty argumentů.
logy Komplexní typ Název kategorie diagnostického protokolu pro typ prostředku. Pokud chcete získat seznam kategorií diagnostických protokolů pro prostředek, proveďte operaci nastavení diagnostiky GET.
kategorie Řetězec Pole kategorií protokolů a jejich zásad uchovávání informací.
timeGrain Řetězec Členitost metrik, které jsou zachyceny ve formátu doby trvání ISO 8601. Hodnota vlastnosti musí být PT1M, která určuje jednu minutu.
povolené logický Určuje, jestli je pro tento zdroj povoleno shromažďování metriky nebo kategorie protokolu.
zásady uchovávání Komplexní typ Popisuje zásady uchovávání informací pro metriku nebo kategorii protokolu. Tato vlastnost se používá pouze pro účty úložiště.
Dny int Počet dnů, po které se mají metriky nebo protokoly uchovávat. Pokud je hodnota vlastnosti 0, protokoly se uchovávají navždy. Tato vlastnost se používá pouze pro účty úložiště.

Odpověď

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/<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
}

Získání informací o nastavení diagnostiky v rozhraní REST API pro monitorování

Žádost

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

Hlavičky

  • Nahraďte {api-version} s 2016-09-01.
  • Nahraďte {resource-id} ID prostředku, pro který chcete upravit nastavení diagnostiky. Další informace najdete v článku Použití skupin prostředků ke správě prostředků Azure.
  • Nastavte záhlaví Content-Type na application/json.
  • Nastavte autorizační hlavičku na webový token JSON, který jste získali z ID Microsoft Entra. Další informace najdete v tématu Ověřování požadavků.

Odpověď

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
}

Další informace najdete v tématu Nastavení diagnostiky.

Související obsah

Monitorování operací služby SSIS pomocí služby Azure Monitor

  • Last updated on