Delen via

Diagnostische logboeken instellen via de Azure Monitor REST API

In dit artikel wordt beschreven hoe u diagnostische logboeken instelt voor Azure Data Factory met behulp van de Azure Monitor REST API.

Instellingen voor diagnostiek

Gebruik diagnostische instellingen om diagnostische logboeken te configureren voor niet-computationele resources. De instellingen voor een resourcebeheer hebben de volgende functies:

  • Ze geven aan waar diagnostische logboeken worden verzonden. Voorbeelden hiervan zijn een Azure-opslagaccount, een Azure Event Hub of Monitor-logboeken.
  • Ze geven aan welke logboekcategorieën worden verzonden.
  • Ze geven aan hoe lang elke logboekcategorie moet worden bewaard in een opslagaccount.
  • Een retentie van nul dagen betekent dat logboeken voor altijd worden bewaard. Anders kan de waarde een willekeurig aantal dagen tussen 1 en 2.147.483.647 zijn.
  • Als het bewaarbeleid is ingesteld, maar het opslaan van logboeken in een opslagaccount is uitgeschakeld, heeft het bewaarbeleid geen effect. Deze voorwaarde kan bijvoorbeeld optreden wanneer alleen Event Hubs of Monitor-logboekopties zijn geselecteerd.
  • Het bewaarbeleid wordt dagelijks toegepast. De grens tussen dagen vindt plaats om middernacht Coordinated Universal Time (UTC). Aan het einde van een dag worden logboeken van dagen die buiten het bewaarbeleid vallen, verwijderd. Als u bijvoorbeeld een bewaarbeleid van één dag hebt, worden de logboeken van vóór gisteren verwijderd aan het begin van vandaag.

Diagnostische logboeken inschakelen via de Monitor REST API

Gebruik de MONITOR REST API om diagnostische logboeken in te schakelen.

Een diagnostische instelling maken of bijwerken in de Monitor REST API

Aanvraag

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

Kopteksten

  • Vervang {api-version} door 2016-09-01.
  • Vervang {resource-id} door de id van de resource waarvoor u diagnostische instellingen wilt bewerken. Zie Resourcegroepen gebruiken om Azure-resources te beheren voor meer informatie.
  • Stel de Content-Type-header in op application/json.
  • Stel de autorisatieheader in op het JSON-webtoken dat u hebt gekregen van Microsoft Entra-id. Zie Aanvragen verifiëren voor meer informatie.

Lichaam

{
    "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": ""
}
Vastgoed Typ Beschrijving
storageAccountId Touwtje De resource-id van het opslagaccount waarnaar u diagnostische logboeken wilt verzenden.
serviceBusRuleId Touwtje De service-bus-regel-id van de service-bus-naamruimte waarin u event hubs wilt maken voor het streamen van logboeken met diagnostische gegevens. De regel-id heeft de indeling {service bus resource ID}/authorizationrules/{key name}.
workspaceId Touwtje De werkruimte-id van de werkruimte waarin de logboeken worden opgeslagen.
Statistieken Parameterwaarden van de pijplijnuitvoering die moeten worden doorgegeven aan de aangeroepen pijplijn Een JSON-object waarmee parameternamen worden toegewezen aan argumentwaarden.
Logs Complexe Type De naam van een categorie voor diagnostisch logboek voor een resourcetype. Om de lijst met diagnostische logboekcategorieën voor een resource op te halen, voert u een GET-operatie voor diagnostische instellingen uit.
category Touwtje Een matrix met logboekcategorieën en hun bewaarbeleid.
timeGrain Touwtje De granulariteit van metrische gegevens, vastgelegd in de ISO 8601-duurnotatie. De waarde van de eigenschap moet zijn PT1M, wat één minuut aangeeft.
ingeschakeld Booleaan Hiermee geeft u op of het verzamelen van de metrische of logboekcategorie is ingeschakeld voor deze resource.
retentiebeleid Complexe Type Beschrijft het bewaarbeleid voor een metrische of logboekcategorie. Deze eigenschap wordt alleen gebruikt voor opslagaccounts.
dagen Integer Het aantal dagen dat de metrische gegevens of logboeken moeten worden bewaard. Als de waarde van de eigenschap 0 is, worden de logboeken voor altijd bewaard. Deze eigenschap wordt alleen gebruikt voor opslagaccounts.

Reactie

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
}

Informatie ophalen over diagnostische instellingen in de Monitor REST API

Aanvraag

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

Kopteksten

  • Vervang {api-version} door 2016-09-01.
  • Vervang {resource-id} door de id van de resource waarvoor u diagnostische instellingen wilt bewerken. Zie Resourcegroepen gebruiken om Azure-resources te beheren voor meer informatie.
  • Stel de Content-Type-header in op application/json.
  • Stel de autorisatieheader in op een JSON-webtoken dat u hebt ontvangen van Microsoft Entra ID. Zie Aanvragen verifiëren voor meer informatie.

Reactie

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
}

Zie Diagnostische instellingen voor meer informatie.

Verwante inhoud

SSIS-bewerkingen bewaken met Azure Monitor

  • Last updated on