Konfigurera diagnostikloggar via Rest-API:et för Azure Monitor

  • Artikel

I den här artikeln beskrivs hur du konfigurerar diagnostikloggar för Azure Data Factory med hjälp av REST-API:et för Azure Monitor.

Diagnostikinställningar

Använd diagnostikinställningar för att konfigurera diagnostikloggar för icke-kompatibla resurser. Inställningarna för en resurskontroll har följande funktioner:

  • De anger var diagnostikloggar skickas. Exempel är ett Azure Storage-konto, en Azure-händelsehubb eller övervakningsloggar.
  • De anger vilka loggkategorier som skickas.
  • De anger hur länge varje loggkategori ska sparas i ett lagringskonto.
  • En kvarhållning på noll dagar innebär att loggar bevaras för alltid. Annars kan värdet vara valfritt antal dagar från 1 till 2 147 483 647.
  • Om kvarhållningsprinciper anges men lagring av loggar i ett lagringskonto är inaktiverat har kvarhållningsprinciperna ingen effekt. Det här villkoret kan till exempel inträffa när endast alternativ för händelsehubbar eller Övervakningsloggar har valts.
  • Kvarhållningsprinciper tillämpas per dag. Gränsen mellan dagar inträffar vid midnatt Coordinated Universal Time (UTC). I slutet av en dag tas loggar från dagar som ligger utanför kvarhållningsprincipen bort. Om du till exempel har en kvarhållningsprincip på en dag tas loggarna från före igår bort i början av dagen.

Aktivera diagnostikloggar via MONITOR REST API

Använd MONITOR REST API för att aktivera diagnostikloggar.

Skapa eller uppdatera en diagnostikinställning i MONITOR REST API

Begär

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

Sidhuvuden

  • Ersätt {api-version} med 2016-09-01
  • Ersätt {resource-id} med ID:t för resursen som du vill redigera diagnostikinställningar för. Mer information finns i Using resource groups to manage your Azure resources (Hantera dina Azure-resurser med hjälp av resursgrupper).
  • Content-Type Ange rubriken till application/json.
  • Ange auktoriseringshuvudet till den JSON-webbtoken som du fick från Microsoft Entra-ID:t. Mer information finns i Autentisera begäranden.

Brödtext

{
    "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": ""
}
Property Type Beskrivning
storageAccountId String Resurs-ID för lagringskontot som du vill skicka diagnostikloggar till.
serviceBusRuleId String Service Bus-regel-ID för service bus-namnområdet där du vill att händelsehubbar ska skapas för diagnostikloggar för direktuppspelning. Regel-ID:t har formatet {service bus resource ID}/authorizationrules/{key name}.
workspaceId String Arbetsytans ID för arbetsytan där loggarna ska sparas.
metrics Parametervärden för pipelinekörningen som ska skickas till den anropade pipelinen Ett JSON-objekt som mappar parameternamn till argumentvärden.
Loggar Komplex typ Namnet på en diagnostikloggkategori för en resurstyp. Utför en get-diagnostikinställningsåtgärd för att hämta listan över diagnostikloggkategorier för en resurs.
Kategori String En matris med loggkategorier och deras kvarhållningsprinciper.
timeGrain String Kornigheten för mått, som samlas in i ISO 8601-varaktighetsformat. Egenskapsvärdet måste vara PT1M, vilket anger en minut.
Aktiverat Booleskt Anger om insamling av måttet eller loggkategorin är aktiverad för den här resursen.
retentionPolicy Komplex typ Beskriver kvarhållningsprincipen för ett mått eller en loggkategori. Den här egenskapen används endast för lagringskonton.
Dagar Int Antal dagar som måtten eller loggarna ska behållas. Om egenskapsvärdet är 0 behålls loggarna för alltid. Den här egenskapen används endast för lagringskonton.

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
}

Hämta information om diagnostikinställningar i MONITOR REST API

Begär

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

Sidhuvuden

  • Ersätt {api-version} med 2016-09-01
  • Ersätt {resource-id} med ID:t för resursen som du vill redigera diagnostikinställningar för. Mer information finns i Using resource groups to manage your Azure resources (Hantera dina Azure-resurser med hjälp av resursgrupper).
  • Content-Type Ange rubriken till application/json.
  • Ange auktoriseringshuvudet till en JSON-webbtoken som du fick från Microsoft Entra-ID. Mer information finns i Autentisera begäranden.

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
}

Mer information finns i Diagnostikinställningar.

Relaterat innehåll

Övervaka SSIS-åtgärder med Azure Monitor