إعداد سجلات التشخيص عبر واجهة برمجة تطبيقات Azure Monitor REST

توضح هذه المقالة كيفية إعداد سجلات تشخيصية لـ Azure Data Factory باستخدام واجهة برمجة تطبيقات REST لـ Azure Monitor.

إعدادات التشخيص

استخدم إعدادات التشخيص لتكوين سجلات التشخيص للموارد غير المتوافقة. تحتوي إعدادات عنصر التحكم بالمورد على الميزات التالية:

• وهي تحدد موضع إرسال سجلات التشخيص. تتضمن الأمثلة حساب تخزين Azure أو لوحة مركز أحداث Azure أو سجلات المراقبة.
• وهي تحدد فئات السجل التي يتم إرسالها.
• وهي تحدد المدة التي يجب أن يتم فيها حفظ كل فئة سجل في حساب تخزين.
• استبقاء صفر من عدد الأيام يعني استبقاء البيانات بسجلات إلى الأبد. وإلا، يمكن أن تكون القيمة أي عدد من الأيام من 1 إلى 2.147.483.647.
• إذا تم تعيين نهج الاستبقاء ولكن تم تعطيل تخزين السجلات في حساب تخزين، فلن يكون لدى نهج الاستبقاء أي تأثير. على سبيل المثال، يمكن أن يحدث هذا الشرط عند تحديد خيارات سجلات المراقبة أو مركز الأحداث فقط.
• يتم تطبيق نهج الاستبقاء كل يوم. الحد الفاصل بين الأيام يحدث في منتصف الليل التوقيت العالمي المتفق عليه (UTC). في نهاية أي يوم، يتم حذف سجلات الأيام التي تتجاوز نهج الاستبقاء. على سبيل المثال، إذا كان لديك نهج الاستبقاء ليوم واحد، في بداية اليوم سيتم حذف السجلات من قبل الأمس.

تمكين سجلات التشخيص عبر واجهة برمجة تطبيقات REST للمراقبة

استخدم واجهة برمجة تطبيقات REST للمراقبة لتمكين سجلات التشخيص.

إنشاء إعداد تشخيص أو تحديثه في واجهة برمجة تطبيقات REST للمراقبة

Request

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

الرؤوس

• استبدل {api-version} بـ 2016-09-01.
• استبدل {resource-id} بمعرف المورد الذي تريد تحرير إعدادات التشخيص له. للمزيد من المعلومات، يُرجى الرجوع إلى استخدام مجموعات الموارد لإدارة موارد Azure.
• وقم بتعيين العوان Content-Type إلى application/json.
• قم بتعيين عنوان التخويل إلى رمز ويب JSON المميز الذي حصلت عليه من معرف Microsoft Entra. لمزيد من المعلومات، راجع طلبات المصادقة.

نص الرسالة

{
    "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": ""
}

الخاصية	نوع	‏‏الوصف
storageAccountId	السلسلة‬	معرف المورد لحساب التخزين الذي تريد إرسال سجلات التشخيص إليه.
serviceBusRuleId	السلسلة‬	معرف قاعدة ناقل الخدمة لمساحة اسم ناقل الخدمة التي تريد إنشاء مراكز أحداث له خاصة بسجلات تشخيص الدفق. معرف القاعدة له التنسيق {service bus resource ID}/authorizationrules/{key name}.
workspaceId	السلسلة‬	معرف مساحة العمل لمساحة العمل حيث سيتم حفظ السجلات.
المقاييس	قيم المعلمات للبنى الأساسية ليتم تمريرها إلى البنية الأساسية التي تم استدعاؤها	عنصر JSON الذي يعين أسماء المعلمات لقيم وسيطة.
السجلات	النوع المعقد	اسم فئة سجل تشخيص لنوع مورد. للحصول على قائمة بفئات السجل التشخيصي لمورد، فقم بإجراء عملية إعدادات تشخيص GET.
الفئة	السلسلة‬	صفيف من فئات السجل ونهج الاستبقاء الخاصة بها.
TimeGrain	السلسلة‬	نقاوة المقاييس، التي يتم تسجيلها بتنسيق مدة ISO 8601. يجب أن تكون قيمة الخاصية PT1M، والتي تحدد دقيقة واحدة.
مُمكَّن	Boolean	تحديد ما إذا كان يتم تمكين مجموعة من فئة القياس أو السجل لهذا المورد.
retentionPolicy	النوع المعقد	توضح هذه المقالة نهج الاستبقاء لفئة قياس أو سجل. يتم استخدام هذه الخاصية لحسابات التخزين فقط.
الأيام	Int	عدد الأيام التي يجب الاحتفاظ بها في المقاييس أو السجلات. إذا كانت قيمة الخاصية 0، يتم الاحتفاظ بالسجلات إلى الأبد. يتم استخدام هذه الخاصية لحسابات التخزين فقط.

الرد

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
}

الحصول على معلومات حول إعدادات التشخيص في واجهة برمجة تطبيقات REST للمراقبة

Request

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

الرؤوس

• استبدل {api-version} بـ 2016-09-01.
• استبدل {resource-id} بمعرف المورد الذي تريد تحرير إعدادات التشخيص له. للمزيد من المعلومات، يُرجى الرجوع إلى استخدام مجموعات الموارد لإدارة موارد Azure.
• وقم بتعيين العوان Content-Type إلى application/json.
• قم بتعيين عنوان التخويل إلى رمز ويب JSON المميز الذي حصلت عليه من معرف Microsoft Entra. لمزيد من المعلومات، راجع طلبات المصادقة.

الرد

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
}

لمزيد من المعلومات، راجع إعدادات التشخيص.

المحتوى ذو الصلة

مراقبة عمليات SSIS باستخدام Azure Monitor