مشاركة عبر

مرجع تعريفات موصل البيانات لإطار عمل الموصل بدون تعليمات برمجية

لإنشاء موصل بيانات باستخدام Codeless Connector Framework (CCF)، استخدم هذا المستند كملحق ل Microsoft Sentinel REST API للمستندات المرجعية لتعريفات موصل البيانات . على وجه التحديد، يتوسع هذا المستند المرجعي في القسم التالي:

  • connectorUiConfig - يحدد العناصر المرئية والنص المعروض على صفحة موصل البيانات في Microsoft Sentinel.

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

تعريفات موصل البيانات - إنشاء أو تحديث

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

أسلوب PUT

https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.OperationalInsights/workspaces/{{workspaceName}}/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/{{dataConnectorDefinitionName}}?api-version={{apiVersion}}

معلمات URI

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

الاسم الوصف
dataConnectorDefinitionName يجب أن يكون تعريف موصل البيانات اسما فريدا وهو نفس المعلمة name في نص الطلب.
اسم مجموعة الموارد اسم مجموعة الموارد، وليس حساسا لحالة الأحرف.
معرف الاشتراك معرف الاشتراك الهدف.
اسم مساحة العمل اسم مساحة العمل، وليس المعرف.
نمط Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
إصدار واجهة برمجة التطبيقات إصدار واجهة برمجة التطبيقات لاستخدامه في هذه العملية.

نص الطلب

يحتوي نص الطلب لإنشاء تعريف موصل بيانات CCF باستخدام واجهة برمجة التطبيقات على البنية التالية:

{
    "kind": "Customizable",
    "properties": {
        "connectorUIConfig": {}
    }
}

يحتوي dataConnectorDefinition على الخصائص التالية:

الاسم مطلوب نوع الوصف
نوع صحيح السلسلة‬ Customizable لموصل بيانات التحقق من واجهة برمجة التطبيقات أو Static غير ذلك
خصائص. ConnectorUiConfig صحيح JSON المتداخل
ConnectorUiConfig		 خصائص تكوين واجهة المستخدم لموصل البيانات

تكوين واجهة مستخدم الموصل

يصف هذا القسم خيارات التكوين المتوفرة لتخصيص واجهة المستخدم لصفحة موصل البيانات.

تظهر لقطة الشاشة التالية عينة من صفحة موصل البيانات، مع تمييزها بالأرقام التي تتوافق مع المناطق البارزة من واجهة المستخدم.

لقطة شاشة لصفحة موصل بيانات نموذجية مع أقسام تسمى من 1 إلى 9.

يتوافق كل عنصر من العناصر التالية في connectorUiConfig القسم المطلوب لتكوين واجهة المستخدم مع جزء CustomizableConnectorUiConfig من واجهة برمجة التطبيقات.

ميدان مطلوب نوع الوصف لقطة شاشة لمنطقة بارزة #
عنوان صحيح سلسلة العنوان المعروض في صفحة موصل البيانات 1
معرف سلسلة تعيين معرف موصل مخصص للاستخدام الداخلي
شعار سلسلة المسار إلى ملف الصورة بتنسيق SVG. إذا لم يتم تكوين أي قيمة، يتم استخدام شعار افتراضي. 2
ناشر صحيح سلسلة موفر الموصل 3
وضع علامة على الوصف صحيح سلسلة في markdown وصف للموصل مع القدرة على إضافة لغة markdown لتحسينه. 4
نماذج الاستعلامات صحيح JSON المتداخل
نماذج الاستعلامات		 استعلامات للعميل لفهم كيفية العثور على البيانات في سجل الأحداث.
استعلام الرسم البياني صحيح JSON المتداخل
استعلام الرسم البياني		 الاستعلامات التي تقدم استيعاب البيانات على مدار الأسبوعين الماضيين.

قم بتوفير استعلام واحد لجميع أنواع بيانات موصل البيانات، أو استعلام مختلف لكل نوع بيانات.		 5
graphQueriesTableName تعيين اسم الجدول الذي يدرج الموصل البيانات إليه. يمكن استخدام هذا الاسم في استعلامات أخرى عن طريق تحديد {{graphQueriesTableName}} العنصر النائب في graphQuerieslastDataReceivedQuery والقيم.
أنواع البيانات صحيح JSON المتداخل
أنواع البيانات		 قائمة بجميع أنواع البيانات للموصل، واستعلام لجلب وقت الحدث الأخير لكل نوع بيانات. 6
connectivityCriteria صحيح JSON المتداخل
connectivityCriteria		 كائن يحدد كيفية التحقق مما إذا كان الموصل متصلا. 7
توافر JSON المتداخل
توافر		 كائن يحدد حالة توفر الموصل.
اذونات صحيح JSON المتداخل
اذونات		 المعلومات المعروضة ضمن قسم المتطلبات الأساسية في واجهة المستخدم، والتي تسرد الأذونات المطلوبة لتمكين الموصل أو تعطيله. 8
خطوات التعليمات صحيح JSON المتداخل
التوجيهات		 صفيف من أجزاء عنصر واجهة المستخدم التي تشرح كيفية تثبيت الموصل، وعناصر التحكم القابلة للتنفيذ المعروضة في علامة التبويب إرشادات . 9
isConnectivityCriteriasMatchSome قيمة منطقية قيمة منطقية تشير إلى ما إذا كنت تريد استخدام "OR" (SOME) أو "AND" بين عناصر ConnectivityCriteria.

معايير الاتصال

ميدان مطلوب نوع الوصف
نوع صحيح السلسلة‬ أحد الخيارين التاليين: HasDataConnectors - هذه القيمة هي الأفضل لموصلات بيانات التحقق من واجهة برمجة التطبيقات مثل CCF. يعتبر الموصل متصلا باتصال نشط واحد على الأقل.

isConnectedQuery – هذه القيمة هي الأفضل للأنوع الأخرى من موصلات البيانات. يعتبر الموصل متصلا عندما يقوم الاستعلام المقدم بإرجاع البيانات.
قيمة صواب عندما يكون النوع isConnectedQuery السلسلة‬ استعلام لتحديد ما إذا تم تلقي البيانات في غضون فترة زمنية معينة. على سبيل المثال: CommonSecurityLog | where DeviceVendor == \"Vectra Networks\"\n| where DeviceProduct == \"X Series\"\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(7d)"

أنواع البيانات

قيمة الصفيف نوع الوصف
الاسم السلسلة‬ وصف ذي معنى ل، بما فيlastDataReceivedQuerygraphQueriesTableName ذلك دعم المتغير.

على سبيل المثال:{{graphQueriesTableName}}
lastDataReceivedQuery السلسلة‬ استعلام KQL الذي يقوم بإرجاع صف واحد، ويشير إلى آخر مرة تم فيها تلقي البيانات، أو عدم وجود بيانات إذا لم تكن هناك نتائج.

على سبيل المثال:{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)

استعلام الرسم البياني

تعريف استعلام يعرض استيعاب البيانات على مدار الأسبوعين الماضيين.

قم بتوفير استعلام واحد لجميع أنواع بيانات موصل البيانات، أو استعلام مختلف لكل نوع بيانات.

قيمة الصفيف نوع الوصف
اسم القياس السلسلة‬ اسم ذي معنى للرسم البياني الخاص بك.

على سبيل المثال:Total data received
أسطورة السلسلة‬ السلسلة التي تظهر في وسيلة الإيضاح إلى يمين المخطط، بما في ذلك مرجع متغير.

على سبيل المثال:{{graphQueriesTableName}}
الاستعلام الأساسي السلسلة‬ الاستعلام الذي يقوم بتصفية الأحداث ذات الصلة، بما في ذلك مرجع متغير.

مثال: TableName_CL | where ProviderName == "myprovider" أو {{graphQueriesTableName}}

availability

ميدان مطلوب نوع الوصف
الحالة رقم صحيح حالة توفر الموصل.
متوفر = 1
علامة الميزة = 2
قريبا = 3
داخلي = 4
isPreview قيمة منطقية قيمة منطقية تشير إلى ما إذا كان الموصل في وضع المعاينة.

اذونات

قيمة الصفيف نوع الوصف
جمارك السلسلة‬ يصف أي أذونات مخصصة مطلوبة لاتصال البيانات، في بناء الجملة التالي:
{
"name":خيط,
"description":خيط
}

مثال: يتم عرض قيمة الجمارك في قسم المتطلبات الأساسية ل Microsoft Sentinel مع أيقونة إعلامية زرقاء. في مثال GitHub، ترتبط هذه القيمة بخط مفتاح الرمز المميز الشخصي لواجهة برمجة تطبيقات GitHub: تحتاج إلى الوصول إلى الرمز المميز الشخصي GitHub...
الرخص قائمة تعداد تعريف التراخيص المطلوبة، على أنها إحدى القيم التالية: OfficeIRM،OfficeATP ، ، Office365AadP1P2، Mcas، Aatp، Mdatp، ، MtpIoT

مثال: تعرض قيمة التراخيص في Microsoft Sentinel كما يلي : الترخيص: مطلوب Azure AD Premium P2
موفر الموارد موفر الموارد توضح هذه المقالة أي متطلبات أساسية لمورد Azure.

مثال: تعرض قيمة resourceProvider في قسم المتطلبات الأساسية ل Microsoft Sentinel على النحو التالي:
مساحة العمل: مطلوب إذن القراءة والكتابة.
المفاتيح: أذونات القراءة للمفاتيح المشتركة لمساحة العمل مطلوبة.
مستاجر صفيف قيم ENUM
على سبيل المثال:

"tenant": [
"GlobalADmin",
"SecurityAdmin"
]
 تعريف الأذونات المطلوبة، كقيمة واحدة أو أكثر من القيم التالية: "GlobalAdmin"، ، "SecurityAdmin"، "SecurityReader""InformationProtection"

مثال: يعرض قيمة المستأجر في Microsoft Sentinel على النحو التالي: أذونات المستأجر: يتطلب Global Administrator أو Security Administrator على مستأجر مساحة العمل

هام

توصي Microsoft باستخدام الأدوار ذات الأذونات القليلة. يساعد ذلك في تحسين الأمان لمؤسستك. يعتبر المسؤول العام دورا متميزا للغاية يجب أن يقتصر على سيناريوهات الطوارئ عندما لا يمكنك استخدام دور موجود.

موفر الموارد

قيمة الصفيف الفرعي نوع الوصف
كاسب قائمة تعداد يصف موفر الموارد، بإحدى القيم التالية:
- Microsoft.OperationalInsights/workspaces
- Microsoft.OperationalInsights/solutions
- Microsoft.OperationalInsights/workspaces/datasources
- microsoft.aadiam/diagnosticSettings
- Microsoft.OperationalInsights/workspaces/sharedKeys
- Microsoft.Authorization/policyAssignments
providerDisplayName السلسلة‬ عنصر قائمة ضمن المتطلبات الأساسية يعرض علامة اختيار حمراء "x" أو خضراء عند التحقق من صحة الأذونات المطلوبة في صفحة الموصل. مثل "Workspace"
permissionsDisplayText السلسلة‬ عرض نص لأذونات القراءة أو الكتابة أو القراءة والكتابة التي يجب أن تتوافق مع القيم المكونة في الأذونات المطلوبة
الأذونات المطلوبة {
"action":منطقيه,
"delete":منطقيه,
"read":منطقيه,
"write":منطقيه
}		 توضح هذه المقالة الحد الأدنى من الأذونات المطلوبة للموصل.
النطاق قائمة تعداد يصف نطاق موصل البيانات، كأحد القيم التالية: "Subscription"، ، "ResourceGroup""Workspace"

نماذج الاستعلامات

قيمة الصفيف نوع الوصف
الوصف السلسلة‬ وصف ذي معنى لعينة الاستعلام.

على سبيل المثال:Top 10 vulnerabilities detected
الاستعلام السلسلة‬ نموذج استعلام يستخدم لجلب بيانات نوع البيانات.

على سبيل المثال:{{graphQueriesTableName}}\n | sort by TimeGenerated\n | take 10

لتعريف ارتباط مضمن باستخدام markdown، استخدم المثال التالي.

{
   "title": "",
   "description": "Make sure to configure the machine's security according to your organization's security policy\n\n\n[Learn more >](https://aka.ms/SecureCEF)"
}

لتعريف ارتباط كقالب ARM، استخدم المثال التالي كدليل:

{
   "title": "Azure Resource Manager (ARM) template",
   "description": "1. Click the **Deploy to Azure** button below.\n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)]({URL to custom ARM template})"
}

خطوات التعليمات

يوفر هذا القسم معلمات تحدد مجموعة الإرشادات التي تظهر على صفحة موصل البيانات في Microsoft Sentinel وتحتوي على البنية التالية:

"instructionSteps": [
    {
        "title": "",
        "description": "",
        "instructions": [
        {
            "type": "",
            "parameters": {}
        }
        ],
        "innerSteps": {}
    }
]
خاصية الصفيف مطلوب نوع الوصف
عنوان السلسلة‬ تعريف عنوان للتعليمات الخاصة بك.
الوصف السلسلة‬ يحدد وصفا ذا معنى للتعليمات الخاصة بك.
الخطوات الداخلية صفيف تعريف صفيف من خطوات التعليمات الداخلية.
التوجيهات صحيح صفيف التعليمات تعريف صفيف من الإرشادات لنوع معلمة معين.

تعليمات

يعرض مجموعة من الإرشادات، مع معلمات مختلفة والقدرة على تداخل المزيد من التعليماتالتضمينات في المجموعات. تتوافق المعلمات المحددة هنا

نوع خاصية الصفيف الوصف
OAuthForm OAuthForm الاتصال ب OAuth
مربع النص مربع النص هذا يقترن ب ConnectionToggleButton. هناك 4 أنواع متوفرة:
  • password
  • text
  • number
  • email
    		•
    ConnectionToggleButton ConnectionToggleButton تشغيل نشر DCR استنادا إلى معلومات الاتصال المتوفرة من خلال معلمات العنصر النائب. المعلمات التالية مدعومة:
  • name :إجباري
  • disabled
  • isPrimary
  • connectLabel
  • disconnectLabel
    		•
    CopyableLabel CopyableLabel إظهار حقل نصي مع زر نسخ في النهاية. عند تحديد الزر، يتم نسخ قيمة الحقل.
    القائمة المنسدلة القائمة المنسدلة يعرض قائمة منسدلة بالخيارات التي يمكن للمستخدم الاختيار منها.
    Markdown Markdown يعرض مقطعا من النص منسقا باستخدام Markdown.
    DataConnectorsGrid DataConnectorsGrid يعرض شبكة من موصلات البيانات.
    جزء السياق جزء السياق يعرض جزء معلومات سياقية.
    InfoMessage InfoMessage تعريف رسالة معلومات مضمنة.
    مجموعة الخطوات الإرشادية مجموعة الخطوات الإرشادية يعرض مجموعة من الإرشادات، موسعة اختياريا أو قابلة للطي، في قسم إرشادات منفصل.
    InstallAgent InstallAgent يعرض ارتباطا إلى أجزاء أخرى من Azure لإنجاز متطلبات التثبيت المختلفة.
    OAuthForm

    يتطلب هذا المكون وجود OAuth2 النوع في auth خاصية قالب موصل البيانات.

    "instructions": [
{
  "type": "OAuthForm",
  "parameters": {
    "clientIdLabel": "Client ID",
    "clientSecretLabel": "Client Secret",
    "connectButtonLabel": "Connect",
    "disconnectButtonLabel": "Disconnect"
  }          
}
]
    مربع النص

    فيما يلي بعض الأمثلة على Textbox النوع. تتوافق هذه الأمثلة مع المعلمات المستخدمة في قسم المثال auth في مرجع موصلات البيانات لإطار عمل الموصل بدون تعليمات برمجية. لكل نوع من الأنواع ال 4، يحتوي labelكل منها على و placeholderو name.

    "instructions": [
{
  "type": "Textbox",
  "parameters": {
      {
        "label": "User name",
        "placeholder": "User name",
        "type": "text",
        "name": "username"
      }
  }
},
{
  "type": "Textbox",
  "parameters": {
      "label": "Secret",
      "placeholder": "Secret",
      "type": "password",
      "name": "password"
  }
}
]
    ConnectionToggleButton
    "instructions": [
{
  "type": "ConnectionToggleButton",
  "parameters": {
    "connectLabel": "toggle",
    "name": "toggle"
  }          
}
]
    CopyableLabel

    على سبيل المثال:

    لقطة شاشة لزر قيمة نسخ في حقل.

    نموذج التعليمات البرمجية:

    {
    "parameters": {
        "fillWith": [
            "WorkspaceId",
            "PrimaryKey"
            ],
        "label": "Here are some values you'll need to proceed.",
        "value": "Workspace is {0} and PrimaryKey is {1}"
    },
    "type": "CopyableLabel"
}
    قيمة الصفيف مطلوب نوع الوصف
    تعبئة مع قائمة تعداد صفيف متغيرات البيئة المستخدمة لتعبئة عنصر نائب. افصل العناصر النائبة المتعددة بفواصل. على سبيل المثال: {0},{1}

    القيم المدعومة: workspaceId، workspaceName، primaryKey، ، MicrosoftAwsAccountsubscriptionId
    تسمية صحيح السلسلة‬ تعريف نص التسمية أعلى مربع نص.
    قيمة صحيح السلسلة‬ يحدد القيمة التي سيتم تقديمها في مربع النص، ويدعم العناصر النائبة.
    الصفوف صفوف تعريف الصفوف في منطقة واجهة المستخدم. بشكل افتراضي، قم بتعيين إلى 1.
    wideLabel قيمة منطقية تحديد تسمية واسعة للسلاسل الطويلة. بشكل افتراضي، قم بتعيين إلى false. 
    {
  "parameters": {
    "label": "Select an option",
    "name": "dropdown",
    "options": [
      {
        "key": "Option 1",
        "text": "option1"
      },
      {
        "key": "Option 2",
        "text": "option2"
      }
    ],
    "placeholder": "Select an option",
    "isMultiSelect": false,
    "required": true,
    "defaultAllSelected": false
  },
  "type": "Dropdown"
}
    ميدان مطلوب نوع الوصف
    تسمية صحيح السلسلة‬ تعريف نص التسمية أعلى القائمة المنسدلة.
    الاسم صحيح السلسلة‬ تعريف الاسم الفريد للمنسدلة. يتم استخدام هذا في تكوين الاستقصاء.
    خيارات صحيح صفيف تعريف قائمة الخيارات للمنسدلة.
    عنصر نائب السلسلة‬ تعريف نص العنصر النائب ل القائمة المنسدلة.
    isMultiSelect قيمة منطقية تحديد ما إذا كان يمكن تحديد خيارات متعددة. بشكل افتراضي، قم بتعيين إلى false.
    مطلوب قيمة منطقية إذا ، trueفإن القائمة المنسدلة مطلوبة للتعبئة.
    defaultAllSelected قيمة منطقية إذا ، trueيتم تحديد جميع الخيارات بشكل افتراضي.
    لغة تنسيق Markdown
    {
  "parameters": {
    "content": "## This is a Markdown section\n\nYou can use **bold** text, _italic_ text, and even [links](https://www.example.com)."
  },
  "type": "Markdown"
}
    DataConnectorsGrid
    {
  "type": "DataConnectorsGrid",
  "parameters": {
    "mapping": [
      {
        "columnName": "Column 1",
        "columnValue": "Value 1"
      },
      {
        "columnName": "Column 2",
        "columnValue": "Value 2"
      }
    ],
    "menuItems": [
      "MyConnector"
    ]
  }
}
    ميدان مطلوب نوع الوصف
    تعيين صحيح صفيف تعريف تعيين الأعمدة في الشبكة.
    عناصر القائمة صفيف تعريف عناصر القائمة للشبكة.
    جزء السياق
    {
  "type": "ContextPane",
  "parameters": {
    "isPrimary": true,
    "label": "Add Account",
    "title": "Add Account",
    "subtitle": "Add Account",
    "contextPaneType": "DataConnectorsContextPane",
    "instructionSteps": [
      {
        "instructions": [
          {
            "type": "Textbox",
            "parameters": {
              "label": "Snowflake Account Identifier",
              "placeholder": "Enter Snowflake Account Identifier",
              "type": "text",
              "name": "accountId",
              "validations": {
                "required": true
              }
            }
          },
          {
            "type": "Textbox",
            "parameters": {
              "label": "Snowflake PAT",
              "placeholder": "Enter Snowflake PAT",
              "type": "password",
              "name": "apikey",
              "validations": {
                "required": true
              }
            }
          }
        ]
      }
    ]
  }
}
    ميدان مطلوب نوع الوصف
    عنوان صحيح السلسلة‬ عنوان جزء السياق.
    عنوان فرعي صحيح السلسلة‬ العنوان الفرعي لجزء السياق.
    contextPaneType صحيح السلسلة‬ نوع جزء السياق.
    خطوات التعليمات صحيح صفيف
    خطوات التعليمات    		 خطوات التعليمات لجزء السياق.
    تسمية السلسلة‬ تسمية جزء السياق.
    isPrimary قيمة منطقية يشير إلى ما إذا كان هذا هو جزء السياق الأساسي.
    InfoMessage

    فيما يلي مثال على رسالة معلومات مضمنة:

    لقطة شاشة لرسالة معلومات مضمنة.

    في المقابل، تعرض الصورة التالية رسالة معلومات غير مضمنة:

    لقطة شاشة لرسالة معلومات غير مضمنة.

    قيمة الصفيف نوع الوصف
    نص السلسلة‬ حدد النص الذي تريد عرضه في الرسالة.
    ظاهر قيمة منطقية تحديد ما إذا كانت الرسالة معروضة أم لا.
    مضمنه قيمة منطقية تحديد كيفية عرض رسالة المعلومات.

    - true: (مستحسن) يعرض رسالة المعلومات المضمنة في الإرشادات.
    - false: يضيف خلفية زرقاء.
    مجموعة الخطوات الإرشادية

    فيما يلي مثال على مجموعة تعليمات قابلة للتوسيع:

    لقطة شاشة لمجموعة تعليمات إضافية قابلة للتوسيع.

    قيمة الصفيف مطلوب نوع الوصف
    عنوان صحيح السلسلة‬ تعريف عنوان خطوة التعليمات.
    الوصف السلسلة‬ نص وصفي اختياري.
    canCollapseAllSections قيمة منطقية تحديد ما إذا كان المقطع أكورديون قابل للطي أم لا.
    noFxPadding قيمة منطقية إذا true، يقلل من ترك مساحة الارتفاع لتوفير مساحة.
    توسيع قيمة منطقية إذا ، trueيظهر على أنه موسع بشكل افتراضي.

    للحصول على مثال مفصل، راجع تكوين JSON لموصل Windows DNS.

    InstallAgent

    تظهر بعض أنواع InstallAgent كزر، بينما يظهر البعض الآخر كارتباط. فيما يلي أمثلة على كليهما:

    لقطة شاشة لارتباط تمت إضافته كزر.

    لقطة شاشة لارتباط تمت إضافته كنص مضمن.

    قيم الصفيف مطلوب نوع الوصف
    نوع الارتباط صحيح قائمة تعداد تحديد نوع الارتباط، كأحد القيم التالية:

    InstallAgentOnWindowsVirtualMachine
    InstallAgentOnWindowsNonAzure
    InstallAgentOnLinuxVirtualMachine
    InstallAgentOnLinuxNonAzure
    OpenSyslogSettings
    OpenCustomLogsSettings
    OpenWaf
    OpenAzureFirewall OpenMicrosoftAzureMonitoring
    OpenFrontDoors
    OpenCdnProfile
    AutomaticDeploymentCEF
    OpenAzureInformationProtection
    OpenAzureActivityLog
    OpenIotPricingModel
    OpenPolicyAssignment
    OpenAllAssignmentsBlade
    OpenCreateDataCollectionRule
    policyDefinitionGuid صواب عند استخدام OpenPolicyAssignment linkType. السلسلة‬ بالنسبة للموصلات المستندة إلى النهج، يحدد GUID لتعريف النهج المضمن.
    تعيين تعديل قائمة تعداد بالنسبة للموصلات المستندة إلى النهج، يعرف وضع التعيين، كأحد القيم التالية: Initiative، Policy
    نوع قواعد تجميع البيانات قائمة تعداد بالنسبة للموصلات المستندة إلى DCR، يعرف نوع قاعدة جمع البيانات إما SecurityEventأو .ForwardEvent

    مثال تعريف موصل البيانات

    يجمع المثال التالي بعض المكونات المعرفة في هذه المقالة بتنسيق نص JSON لاستخدامه مع واجهة برمجة تطبيقات تعريف موصل البيانات إنشاء أو تحديث.

    لمزيد من الأمثلة على connectorUiConfig مراجعة موصلات بيانات CCF الأخرى. حتى الموصلات التي تستخدم CCF القديمة لها أمثلة صالحة لإنشاء واجهة المستخدم.

    {
    "kind": "Customizable",
    "properties": {
        "connectorUiConfig": {
          "title": "Example CCF Data Connector",
          "publisher": "My Company",
          "descriptionMarkdown": "This is an example of data connector",
          "graphQueriesTableName": "ExampleConnectorAlerts_CL",
          "graphQueries": [
            {
              "metricName": "Alerts received",
              "legend": "My data connector alerts",
              "baseQuery": "{{graphQueriesTableName}}"
            },   
           {
              "metricName": "Events received",
              "legend": "My data connector events",
              "baseQuery": "ASIMFileEventLogs"
            }
          ],
            "sampleQueries": [
            {
                "description": "All alert logs",
                "query": "{{graphQueriesTableName}} \n | take 10"
            }
          ],
          "dataTypes": [
            {
              "name": "{{graphQueriesTableName}}",
              "lastDataReceivedQuery": "{{graphQueriesTableName}} \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
            },
             {
              "name": "ASIMFileEventLogs",
              "lastDataReceivedQuery": "ASIMFileEventLogs \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
             }
          ],
          "connectivityCriteria": [
            {
              "type": "HasDataConnectors"
            }
          ],
          "permissions": {
            "resourceProvider": [
              {
                "provider": "Microsoft.OperationalInsights/workspaces",
                "permissionsDisplayText": "Read and Write permissions are required.",
                "providerDisplayName": "Workspace",
                "scope": "Workspace",
                "requiredPermissions": {
                  "write": true,
                  "read": true,
                  "delete": true
                }
              },
            ],
            "customs": [
              {
                "name": "Example Connector API Key",
                "description": "The connector API key username and password is required"
              }
            ] 
        },
          "instructionSteps": [
            {
              "title": "Connect My Connector to Microsoft Sentinel",
              "description": "To enable the connector provide the required information below and click on Connect.\n>",
              "instructions": [
               {
                  "type": "Textbox",
                  "parameters": {
                    "label": "User name",
                    "placeholder": "User name",
                    "type": "text",
                    "name": "username"
                  }
                },
                {
                  "type": "Textbox",
                  "parameters": {
                    "label": "Secret",
                    "placeholder": "Secret",
                    "type": "password",
                    "name": "password"
                  }
                },
                {
                  "type": "ConnectionToggleButton",
                  "parameters": {
                    "connectLabel": "toggle",
                    "name": "toggle"
                  }
                }
              ]
            }
          ]
        }
    }
}
    • Last updated on