Configurare i log di diagnostica tramite l'API REST di Monitoraggio di Azure

  • Articolo

Questo articolo descrive come configurare i log di diagnostica per Azure Data Factory usando l'API REST di Monitoraggio di Azure.

Impostazioni di diagnostica

Usare le impostazioni di diagnostica per configurare i log di diagnostica per le risorse non incompute. Le impostazioni per un controllo delle risorse hanno le funzionalità seguenti:

  • Specificano dove vengono inviati i log di diagnostica. Gli esempi includono un account di archiviazione di Azure, un hub eventi di Azure o i log di Monitoraggio.
  • Specificano le categorie di log inviate.
  • Specificano per quanto tempo ogni categoria di log deve essere mantenuta in un account di archiviazione.
  • Un periodo di conservazione di zero giorni significa che i log vengono conservati all'infinito. In caso contrario, il valore può essere qualsiasi numero di giorni compreso tra 1 e 2.147.483.647.
  • Se i criteri di conservazione sono impostati ma l'archiviazione dei log in un account di archiviazione è disabilitata, i criteri di conservazione non hanno alcun effetto. Ad esempio, questa condizione può verificarsi quando sono selezionate solo le opzioni hub eventi o Monitor logs .
  • I criteri di conservazione vengono applicati al giorno. Il limite tra giorni si verifica a mezzanotte utc (Coordinated Universal Time). Alla fine di un giorno, i log di giorni che superano i criteri di conservazione vengono eliminati. Ad esempio, se si dispone di un criterio di conservazione di un giorno, all'inizio di oggi i log precedenti a ieri vengono eliminati.

Abilitare i log di diagnostica tramite l'API REST di monitoraggio

Usare l'API REST di monitoraggio per abilitare i log di diagnostica.

Creare o aggiornare un'impostazione di diagnostica nell'API REST di monitoraggio

Richiesta

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

Intestazioni

  • Sostituisci {api-version} con 2016-09-01.
  • Sostituire {resource-id} con l'ID della risorsa per cui si desidera modificare le impostazioni di diagnostica. Per altre informazioni, vedere Using resource groups to manage your Azure resources (Uso di Gruppi di risorse per gestire le risorse di Azure).
  • Impostare l'intestazione Content-Type su application/json.
  • Impostare l'intestazione dell'autorizzazione sul token Web JSON ottenuto da Microsoft Entra ID. Per altre informazioni, vedere Autenticazione delle richieste.

Corpo

{
    "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": ""
}
Proprietà Type Descrizione
storageAccountId Stringa ID risorsa dell'account di archiviazione a cui inviare i log di diagnostica.
serviceBusRuleId Stringa ID regola del bus di servizio dello spazio dei nomi del bus di servizio in cui si vogliono creare hub eventi per i log di diagnostica di streaming. L'ID regola ha il formato {service bus resource ID}/authorizationrules/{key name}.
workspaceId Stringa ID dell'area di lavoro in cui verranno salvati i log.
metrics Valori di parametri della pipeline eseguita da passare alla pipeline richiamata Oggetto JSON che esegue il mapping dei nomi dei parametri ai valori degli argomenti.
logs Tipo complesso Nome di una categoria di log di diagnostica per un tipo di risorsa. Per ottenere l'elenco delle categorie di log di diagnostica per una risorsa, eseguire un'operazione di impostazioni di diagnostica GET.
category Stringa Matrice di categorie di log e dei relativi criteri di conservazione.
timeGrain Stringa Granularità delle metriche, acquisite nel formato di durata ISO 8601. Il valore della proprietà deve essere PT1M, che specifica un minuto.
abilitata Boolean Specifica se la raccolta della metrica o della categoria di log è abilitata per questa risorsa.
Retentionpolicy Tipo complesso Descrive i criteri di conservazione per una metrica o categoria di log. Questa proprietà viene usata solo per gli account di archiviazione.
days Int Numero di giorni per mantenere le metriche o i log. Se il valore della proprietà è 0, i log vengono mantenuti per sempre. Questa proprietà viene usata solo per gli account di archiviazione.

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
}

Ottenere informazioni sulle impostazioni di diagnostica nell'API REST di monitoraggio

Richiesta

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

Intestazioni

  • Sostituisci {api-version} con 2016-09-01.
  • Sostituire {resource-id} con l'ID della risorsa per cui si desidera modificare le impostazioni di diagnostica. Per altre informazioni, vedere Using resource groups to manage your Azure resources (Uso di Gruppi di risorse per gestire le risorse di Azure).
  • Impostare l'intestazione Content-Type su application/json.
  • Impostare l'intestazione dell'autorizzazione su un token Web JSON ottenuto da Microsoft Entra ID. Per altre informazioni, vedere Autenticazione delle richieste.

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
}

Per altre informazioni, vedere Impostazioni di diagnostica.

Contenuto correlato

Monitorare le operazioni di SSIS con Monitoraggio di Azure