Compartir vía

Configuración de registros de diagnóstico mediante la API REST de Azure Monitor

En este artículo se describe cómo configurar registros de diagnóstico para Azure Data Factory mediante la API REST de Azure Monitor.

Configuración de diagnóstico

Use la configuración de diagnóstico para configurar los registros de diagnóstico para los recursos que no son de proceso. La configuración de un control de recursos tiene las siguientes características:

  • Especifican dónde se envían los registros de diagnóstico. Algunos ejemplos son una cuenta de Almacenamiento de Azure, un centro de eventos de Azure o registros de Monitor.
  • Especifican qué categorías de registro se envían.
  • Especifican cuánto tiempo se debe conservar cada categoría de registro en una cuenta de almacenamiento.
  • Una retención de cero días significa que los registros se conservan para siempre. De lo contrario, el valor puede ser cualquier número de días comprendido entre 1 y 2.147.483.647.
  • Si se establecen directivas de retención, pero el almacenamiento de registros en una cuenta de almacenamiento está deshabilitado, las directivas de retención no tienen ningún efecto. Por ejemplo, esta condición puede ocurrir cuando solo se seleccionan las opciones de centros de eventos o supervisión de registros.
  • Las directivas de retención se aplican diariamente. El límite entre días se produce a medianoche hora universal coordinada (UTC). Al final de un día, se eliminan los registros de días que van más allá de la directiva de retención. Por ejemplo, si tiene una directiva de retención de un día, al principio de hoy se eliminan los registros de antes de ayer.

Habilitación de registros de diagnóstico a través de la API REST de supervisión

Use el API REST de Monitor para habilitar los registros de diagnóstico.

Creación o actualización de una configuración de diagnóstico en la API REST de supervisión

Solicitud

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

Headers

  • Reemplace {api-version} por 2016-09-01.
  • Reemplace por {resource-id} el identificador del recurso para el que desea editar la configuración de diagnóstico. Para obtener más información, consulte Uso de grupos de recursos para administrar los recursos de Azure.
  • Establezca el encabezado Content-Type en application/json.
  • Establezca el encabezado de autorización en el token web JSON que ha obtenido de Microsoft Entra ID. Para obtener más información, consulte Autenticación de solicitudes.

Body

{
    "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": ""
}
Propiedad Tipo Descripción
storageAccountId String Identificador de recurso de la cuenta de almacenamiento a la que desea enviar registros de diagnóstico.
serviceBusRuleId String El id. de regla de Service Bus para el espacio de nombres de Service Bus donde quiere tener los centros de eventos creados para la transmisión de los registros de diagnóstico. El identificador de regla tiene el formato {service bus resource ID}/authorizationrules/{key name}.
workspaceId String Identificador de área de trabajo del área de trabajo donde se guardarán los registros.
métricas Valores de parámetros de la ejecución de canalización que se pasan a la canalización invocada Objeto JSON que asigna nombres de parámetro a valores de argumento.
Registros Tipo complejo Nombre de una categoría de registro de diagnóstico para un tipo de recurso. Para obtener la lista de categorías de registro de diagnóstico de un recurso, realice una operación de configuración de diagnóstico GET.
categoría String Matriz de las categorías de registro y sus directivas de retención.
timeGrain String Granularidad de las métricas que se capturan en formato de duración ISO 8601. El valor de la propiedad debe ser PT1M, que especifica un minuto.
habilitado Boolean Especifica si la recopilación de la métrica o la categoría de registro está habilitada para este recurso.
política de retención Tipo complejo Describe la directiva de retención para una categoría de métrica o registro. Esta propiedad solo se usa para las cuentas de almacenamiento.
días Int Número de días para mantener las métricas o registros. Si el valor de la propiedad es 0, los registros se conservan para siempre. Esta propiedad solo se usa para las cuentas de almacenamiento.

Respuesta

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
}

Obtención de información sobre la configuración de diagnóstico en la API REST de supervisión

Solicitud

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

Headers

  • Reemplace {api-version} por 2016-09-01.
  • Reemplace por {resource-id} el identificador del recurso para el que desea editar la configuración de diagnóstico. Para obtener más información, consulte Uso de grupos de recursos para administrar los recursos de Azure.
  • Establezca el encabezado Content-Type en application/json.
  • Establezca el encabezado de autorización en un token web de JSON que ha obtenido de Microsoft Entra ID. Para obtener más información, consulte Autenticación de solicitudes.

Respuesta

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
}

Para obtener más información, consulte Configuración de diagnóstico.

Contenido relacionado

Supervisión de operaciones de SSIS con Azure Monitor

  • Last updated on