Sdílet prostřednictvím

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

  • Článek

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

Nastavení diagnostiky

Nastavení diagnostiky slouží ke konfiguraci diagnostických protokolů pro nekompatibilní prostředky. 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ě.
  • Nastavení doby uchovávání na 0 dní znamená, že se protokoly uchovávají trvale. 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í za den. 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.

Povolení diagnostických protokolů prostřednictvím rozhraní REST API pro monitorování

K povolení diagnostických protokolů použijte rozhraní REST API pro monitorování.

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

Požádat

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

Hlavičky

  • Nahraďte {api-version} 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.
  • Content-Type Nastavte záhlaví na application/jsonhodnotu .
  • 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ů.

Body

{
    "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": ""
}
Vlastnost Type Popis
storageAccountId String ID prostředku účtu úložiště, do kterého chcete odesílat diagnostické protokoly.
serviceBusRuleId String ID pravidla služby Service-Bus oboru názvů služby Service-Bus, ve kterém chcete mít centra událostí vytvořená pro protokoly diagnostiky streamování. ID pravidla má formát {service bus resource ID}/authorizationrules/{key name}.
workspaceId String ID pracovního prostoru pracovního prostoru, do kterého se protokoly uloží.
metriky Hodnoty parametrů spuštění kanálu, které se mají předat do vyvolaného kanálu Objekt JSON, který mapuje názvy parametrů na hodnoty argumentů.
Protokoly 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 String Pole kategorií protokolů a jejich zásad uchovávání informací.
timeGrain String Členitost metrik, které jsou zachyceny ve formátu doby trvání ISO 8601. Hodnota vlastnosti musí být PT1M, která určuje jednu minutu.
Povoleno Boolean Určuje, jestli je pro tento prostředek povolená kolekce metriky nebo kategorie protokolu.
retentionPolicy 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ě.
Dní 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ěď respondenta

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í

Požádat

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

Hlavičky

  • Nahraďte {api-version} 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.
  • Content-Type Nastavte záhlaví na application/jsonhodnotu .
  • 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ěď respondenta

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