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

  • Artykuł

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 niezgodnych. 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 przez zero dni oznacza, że dzienniki są przechowywane w nieskończoność. W przeciwnym razie wartość może być dowolną liczbą dni z zakresu od 1 do 2 147 483 647.
  • Jeśli zasady przechowywania są ustawione, ale przechowywanie dzienników na koncie magazynu jest wyłączone, zasady przechowywania nie mają wpływu. Na przykład ten warunek może wystąpić, gdy wybrano tylko opcje dzienników centrów zdarzeń lub Monitor.
  • Zasady przechowywania są stosowane dziennie. 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 API REST monitorowania

Użyj interfejsu API REST monitora, aby włączyć dzienniki diagnostyczne.

Tworzenie lub aktualizowanie ustawienia diagnostyki w interfejsie API REST monitora

Zażądaj

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).
  • Content-Type Ustaw nagłówek na application/json.
  • Ustaw nagłówek autoryzacji na token internetowy JSON uzyskany z identyfikatora Entra firmy Microsoft. Aby uzyskać więcej informacji, zobacz Uwierzytelnianie żądań.

Treść

{
    "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": ""
}
Właściwość Type Opis
storageAccountId String Identyfikator zasobu konta magazynu, do którego chcesz wysyłać dzienniki diagnostyczne.
serviceBusRuleId String Identyfikator reguły usługi Service-bus przestrzeni nazw usługi Service-Bus, w której mają być utworzone centra zdarzeń na potrzeby przesyłania strumieniowego dzienników diagnostycznych. Identyfikator reguły ma format {service bus resource ID}/authorizationrules/{key name}.
workspaceId String Identyfikator obszaru roboczego obszaru roboczego, w którym zostaną zapisane dzienniki.
metrics 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.
Kategorii String Tablica kategorii dzienników i ich zasad przechowywania.
timeGrain String Stopień szczegółowości metryk, które są przechwytywane w formacie czasu trwania ISO 8601. Wartość właściwości musi mieć PT1Mwartość , która określa minutę.
Włączone Wartość logiczna Określa, czy kolekcja kategorii metryk lub dziennika jest włączona dla tego zasobu.
retentionPolicy Typ złożony Opisuje zasady przechowywania dla metryki lub kategorii dziennika. Ta właściwość jest używana tylko dla kont magazynu.
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 magazynu.

Response

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
}

Uzyskiwanie informacji o ustawieniach diagnostycznych w interfejsie API REST monitorowania

Zażądaj

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).
  • Content-Type Ustaw nagłówek na application/json.
  • Ustaw nagłówek autoryzacji na token internetowy JSON uzyskany z identyfikatora Entra firmy Microsoft. Aby uzyskać więcej informacji, zobacz Uwierzytelnianie żądań.

Response

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