Udostępnij przez

Konfigurowanie dzienników diagnostycznych za pośrednictwem interfejsu API REST usługi Azure Monitor

W tym artykule opisano sposób konfigurowania dzienników diagnostycznych dla usługi Azure Data Factory przy użyciu interfejsu API REST usługi Azure Monitor.

Ustawienia diagnostyczne

Użyj ustawień diagnostycznych, aby skonfigurować dzienniki diagnostyczne dla zasobów nieobliczeniowych. Ustawienia kontroli zasobów mają następujące funkcje:

  • Określają, gdzie są wysyłane dzienniki diagnostyczne. Przykłady obejmują konto usługi Azure Storage, centrum zdarzeń platformy Azure lub dzienniki monitora.
  • Określają, które kategorie dzienników są wysyłane.
  • Określają one, jak długo każda kategoria dziennika powinna być przechowywana na koncie magazynu.
  • Przechowywanie zera dni oznacza, że dzienniki są przechowywane na zawsze. W przeciwnym razie wartość może być dowolną liczbą dni z zakresu od 1 do 2 147 483 647.
  • Jeśli wprawdzie zasady przechowywania są ustawione, ale przechowywanie dzienników na koncie magazynu jest wyłączone, zasady te nie mają żadnego wpływu. Na przykład ten warunek może wystąpić, gdy wybrano tylko opcje centra zdarzeń lub dzienniki monitorowania.
  • Zasady przechowywania są stosowane na każdy dzień. Granica między dniami występuje o północy czasu uniwersalnego koordynowanego (UTC). Po zakończeniu dnia dzienniki z dni, które wykraczają poza zasady przechowywania, są usuwane. Jeśli na przykład masz zasady przechowywania jednego dnia, na początku dnia dzienniki sprzed wczoraj zostaną usunięte.

Włączanie dzienników diagnostycznych za pośrednictwem interfejsu Monitor REST API

Użyj interfejsu REST API Monitor, aby aktywować logi diagnostyczne.

Tworzenie lub aktualizowanie ustawienia diagnostyki w interfejsie API REST "Monitor"

Żądanie

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

Nagłówki

  • Zamień {api-version} na 2016-09-01.
  • Zastąp {resource-id} element identyfikatorem zasobu, dla którego chcesz edytować ustawienia diagnostyczne. Więcej informacji można znaleźć w temacie Using resource groups to manage your Azure resources (Używanie grup zasobów do zarządzania zasobami platformy Azure).
  • Ustaw nagłówek Content-Type na wartość application/json.
  • Ustaw nagłówek autoryzacji na token internetowy JSON, który otrzymałeś z Microsoft Entra ID. Aby uzyskać więcej informacji, zobacz Uwierzytelnianie żądań.

Ciało

{
    "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": ""
}
Majątek Typ Opis
storageAccountId Sznurek Identyfikator zasobu konta magazynowego, do którego chcesz wysyłać logi diagnostyczne.
serviceBusRuleId Sznurek Identyfikator reguły przestrzeni nazw Service-Bus, w której mają być utworzone koncentratory zdarzeń do przesyłania strumieniowego dzienników diagnostycznych. Identyfikator reguły ma format {service bus resource ID}/authorizationrules/{key name}.
workspaceId Sznurek Identyfikator obszaru roboczego, w którym zostaną zapisane dzienniki.
Metryki Wartości parametrów przebiegu potoku do przekazania do wywoływanego potoku Obiekt JSON, który mapuje nazwy parametrów na wartości argumentów.
Dzienniki Typ złożony Nazwa kategorii dziennika diagnostycznego dla typu zasobu. Aby uzyskać listę kategorii dzienników diagnostycznych dla zasobu, wykonaj operację GET ustawień diagnostycznych.
kategoria Sznurek Tablica kategorii dzienników i ich zasad przechowywania.
timeGrain Sznurek Stopień szczegółowości metryk, które są przechwytywane w formacie czasu trwania ISO 8601. Wartość właściwości musi wynosić PT1M, co oznacza jedną minutę.
włączone Boolean Określa, czy zbieranie kategorii metryk lub dziennika jest włączone dla tego zasobu.
polityka przechowywania Typ złożony Opisuje politykę retencji dla metryki lub kategorii logów. Ta właściwość jest używana tylko dla kont przechowywania.
Dni Int Liczba dni przechowywania metryk lub dzienników. Jeśli wartość właściwości to 0, dzienniki są przechowywane na zawsze. Ta właściwość jest używana tylko dla kont przechowywania.

Odpowiedź

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
}

Uzyskaj informacje o ustawieniach diagnostycznych w Monitor REST API

Żądanie

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

Nagłówki

  • Zamień {api-version} na 2016-09-01.
  • Zastąp {resource-id} element identyfikatorem zasobu, dla którego chcesz edytować ustawienia diagnostyczne. Więcej informacji można znaleźć w temacie Using resource groups to manage your Azure resources (Używanie grup zasobów do zarządzania zasobami platformy Azure).
  • Ustaw nagłówek Content-Type na wartość application/json.
  • Ustaw nagłówek autoryzacji na token internetowy JSON uzyskany z identyfikatora Entra firmy Microsoft. Aby uzyskać więcej informacji, zobacz Uwierzytelnianie żądań.

Odpowiedź

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
}

Aby uzyskać więcej informacji, zobacz Ustawienia diagnostyczne.

Powiązana zawartość

Monitorowanie operacji SSIS za pomocą usługi Azure Monitor

  • Last updated on