Aracılığıyla paylaş

Kodsuz Bağlayıcı Platformu için veri bağlayıcısı tanımları başvurusu

  • Makale

Kodsuz Bağlayıcı Platformu (CCP) ile veri bağlayıcısı oluşturmak için bu belgeyi Veri Bağlayıcısı Tanımları için Microsoft Sentinel REST API başvuru belgelerine ek olarak kullanın. Özellikle bu başvuru belgesi aşağıdaki bölümde genişler:

  • connectorUiConfig - Microsoft Sentinel'de veri bağlayıcısı sayfasında görüntülenen görsel öğeleri ve metni tanımlar.

Daha fazla bilgi için bkz . Kodsuz bağlayıcı oluşturma.

Veri bağlayıcısı tanımları - Oluşturma veya güncelleştirme

En son kararlı veya önizleme API'sinin sürümünü bulmak için REST API belgelerindeki Oluştur veya Güncelleştir işlemine başvurun. update Yalnızca işlem değeri gerektiriretag.

PUT yöntemi

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

URI parametreleri

En son API sürümü hakkında daha fazla bilgi için bkz . Veri Bağlayıcısı Tanımları - URI Parametrelerini Oluşturma veya Güncelleştirme

Veri Akışı Adı Açıklama
dataConnectorDefinitionName Veri bağlayıcısı tanımı benzersiz bir ad olmalıdır ve istek gövdesindeki parametreyle name aynıdır.
resourceGroupName Büyük/küçük harfe duyarlı değil, kaynak grubunun adı.
subscriptionId Hedef aboneliğin kimliği.
workspaceName Kimlik yerine çalışma alanının adı .
Regex deseni: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api sürümü Bu işlem için kullanılacak API sürümü.

Request body

API ile CCP veri bağlayıcısı tanımı oluşturmaya yönelik istek gövdesi aşağıdaki yapıya sahiptir:

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

dataConnectorDefinition aşağıdaki özelliklere sahiptir:

Veri Akışı Adı Zorunlu Türü Açıklama
Tip Doğru String Customizable API yoklama veri bağlayıcısı için veya Static başka bir şekilde
Özellikler.connectorUiConfig True İç İçe JSON
connectorUiConfig		 Veri bağlayıcısının kullanıcı arabirimi yapılandırma özellikleri

Bağlayıcınızın kullanıcı arabirimini yapılandırma

Bu bölümde, veri bağlayıcısı sayfasının kullanıcı arabirimini özelleştirmek için kullanılabilen yapılandırma seçenekleri açıklanmaktadır.

Aşağıdaki ekran görüntüsünde, kullanıcı arabiriminin önemli alanlarına karşılık gelen sayılarla vurgulanmış örnek bir veri bağlayıcısı sayfası gösterilmektedir.

1 ile 9 arasında etiketlenmiş bölümler içeren örnek veri bağlayıcısı sayfasının ekran görüntüsü.

Kullanıcı arabirimini yapılandırmak için gereken bölümün connectorUiConfig aşağıdaki öğelerinin her biri API'nin CustomizableConnectorUiConfig bölümüne karşılık gelir.

Alan Zorunlu Türü Açıklama Önemli alanın ekran görüntüsü #
başlık Doğru Dize Veri bağlayıcısı sayfasında görüntülenen başlık 1
id dize İç kullanım için özel bağlayıcı kimliğini ayarlar
logo Dize SVG biçiminde görüntü dosyasının yolu. Hiçbir değer yapılandırılmamışsa varsayılan bir logo kullanılır. 2
yayınevi Doğru Dize Bağlayıcının sağlayıcısı 3
descriptionMarkdown True markdown'da dize Bağlayıcıyı geliştirmek için markdown dili ekleme özelliğine sahip bir açıklama. 4
sampleQueries True İç İçe JSON
sampleQueries		 Müşterinin olay günlüğündeki verileri nasıl bulacağını anlaması için sorgular.
graphQueries True İç İçe JSON
graphQueries		 Son iki hafta içinde veri alımı sunan sorgular.

Veri bağlayıcısının tüm veri türleri için bir sorgu veya her veri türü için farklı bir sorgu sağlayın.		 5
graphQueriesTableName Bağlayıcının veri ekli olduğu tablonun adını ayarlar. Bu ad, ve lastDataReceivedQuery değerlerinin yer tutucusu belirtilerek {{graphQueriesTableName}} diğer sorgularda graphQueries kullanılabilir.
dataTypes True İç İçe JSON
dataTypes		 Bağlayıcınız için tüm veri türlerinin listesi ve her veri türü için son olayın saatini getirmek için bir sorgu. 6
connectivityCriteria True İç İçe JSON
connectivityCriteria		 Bağlayıcının bağlı olup olmadığını doğrulamayı tanımlayan bir nesne. 7
permissions True İç İçe JSON
permissions		 Kullanıcı arabiriminin Önkoşullar bölümünde görüntülenen bilgiler, bağlayıcıyı etkinleştirmek veya devre dışı bırakmak için gereken izinleri listeler. 8
instructionSteps True İç İçe JSON
Talimat -ları		 Bağlayıcının nasıl yükleneceğini açıklayan pencere öğesi parçaları dizisi ve Yönergeler sekmesinde görüntülenen eyleme dönüştürülebilir denetimler . 9

connectivityCriteria

Alan Zorunlu Türü Açıklama
Tür Doğru String Aşağıdaki iki seçenek arasında yer alır: HasDataConnectors – Bu değer CCP gibi API yoklama veri bağlayıcıları için idealdir. Bağlayıcının en az bir etkin bağlantıyla bağlı olduğu kabul edilir.

isConnectedQuery – bu değer diğer veri bağlayıcısı türleri için en iyisidir. Sağlanan sorgu veri döndürdüğünde bağlayıcının bağlı olduğu kabul edilir.
Değer Tür olduğunda true isConnectedQuery String Verilerin belirli bir süre içinde alındığını belirlemek için bir sorgu. Örneğin: CommonSecurityLog | where DeviceVendor == \"Vectra Networks\"\n| where DeviceProduct == \"X Series\"\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(7d)"

dataTypes

Dizi Değeri Type Açıklama
ad String değişkeni içinlastDataReceivedQuery destek de dahil olmak üzere için anlamlı bir graphQueriesTableName açıklama.

Örnek: {{graphQueriesTableName}}
lastDataReceivedQuery String Bir satır döndüren ve verilerin en son ne zaman alındığını belirten veya sonuç yoksa veri içermeyen bir KQL sorgusu.

Örnek: {{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)

graphQueries

Son iki hafta içinde veri alımı sunan bir sorgu tanımlar.

Veri bağlayıcısının tüm veri türleri için bir sorgu veya her veri türü için farklı bir sorgu sağlayın.

Dizi Değeri Type Açıklama
metricName String Grafınız için anlamlı bir ad.

Örnek: Total data received
efsane String Değişken başvurusu dahil olmak üzere grafiğin sağındaki göstergede görünen dize.

Örnek: {{graphQueriesTableName}}
baseQuery String Değişken başvurusu da dahil olmak üzere ilgili olayları filtreleyen sorgu.

Örnek: TableName_CL | where ProviderName == "myprovider" veya {{graphQueriesTableName}}

izinler

Dizi değeri Type Açıklama
gümrük String Veri bağlantınız için gereken tüm özel izinleri aşağıdaki söz diziminde açıklar:
{
"name":string,
"description":dizgi
}

Örnek: Microsoft Sentinel Önkoşulları bölümünde gümrük değeri mavi bir bilgilendirme simgesiyle görüntülenir. GitHub örneğinde bu değer GitHub API kişisel belirteç Anahtarı satırıyla ilişkilendirilir: GitHub kişisel belirtecine erişmeniz gerekiyor...
Lisans SABIT LISTESI Gerekli lisansları şu değerlerden biri olarak tanımlar: ,, , , AadP1P2, Mcas, Aatp, Mdatp, MtpOffice365OfficeATPOfficeIRMIoT

Örnek: Microsoft Sentinel'de lisans değeri şu şekilde görüntülenir: Lisans: Gerekli Azure AD Premium P2
resourceProvider resourceProvider Azure kaynağınız için önkoşulları açıklar.

Örnek: resourceProvider değeri Microsoft Sentinel Önkoşulları bölümünde şu şekilde görüntülenir:
Çalışma alanı: okuma ve yazma izni gereklidir.
Anahtarlar: Çalışma alanı için paylaşılan anahtarlar için okuma izinleri gereklidir.
tenant ENUM değerleri dizisi
Örnek:

"tenant": [
"GlobalADmin",
"SecurityAdmin"
]
 Gerekli izinleri şu değerlerden biri veya daha fazlası olarak tanımlar: "GlobalAdmin", "SecurityAdmin", "SecurityReader", , "InformationProtection"

Örnek: Microsoft Sentinel'de kiracı değerini şu şekilde görüntüler: Kiracı İzinleri: Çalışma Global Administrator alanının kiracısında veya Security Administrator gerektirir

Önemli

Microsoft, rolleri en az izinle kullanmanızı önerir. Bu, kuruluşunuzun güvenliğini artırmaya yardımcı olur. Genel Yönetici, mevcut bir rolü kullanamıyorsanız acil durum senaryolarıyla sınırlı olması gereken yüksek ayrıcalıklı bir roldür.

resourceProvider

alt dizi değeri Type Açıklama
Sağlayıcı SABIT LISTESI Kaynak sağlayıcısını aşağıdaki değerlerden biriyle açıklar:
- Microsoft.OperationalInsights/workspaces
- Microsoft.OperationalInsights/solutions
- Microsoft.OperationalInsights/workspaces/datasources
- microsoft.aadiam/diagnosticSettings
- Microsoft.OperationalInsights/workspaces/sharedKeys
- Microsoft.Authorization/policyAssignments
providerDisplayName String Bağlayıcı sayfasında requiredPermissions doğrulandığında Önkoşullar altında kırmızı bir "x" veya yeşil onay işareti görüntüleyen liste öğesi. Örnek "Workspace"
permissionsDisplayText String RequiredPermissions içinde yapılandırılan değerlere karşılık gelen Okuma, Yazma veya Okuma ve Yazma izinlerinin metnini görüntüleme
requiredPermissions {
"action":Boolean,
"delete":Boolean,
"read":Boolean,
"write":Boolean
}		 Bağlayıcı için gereken en düşük izinleri açıklar.
kapsam SABIT LISTESI Veri bağlayıcısının kapsamını şu değerlerden biri olarak açıklar: "Subscription", "ResourceGroup", "Workspace"

sampleQueries

dizi değeri Type Açıklama
Açıklama String Örnek sorgu için anlamlı bir açıklama.

Örnek: Top 10 vulnerabilities detected
query String Veri türünün verilerini getirmek için kullanılan örnek sorgu.

Örnek: {{graphQueriesTableName}}\n | sort by TimeGenerated\n | take 10

Markdown kullanarak satır içi bağlantı tanımlamak için aşağıdaki örneği kullanın.

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

Bağlantıyı ARM şablonu olarak tanımlamak için aşağıdaki örneği kılavuz olarak kullanın:

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

instructionSteps

Bu bölüm, Microsoft Sentinel'de veri bağlayıcısı sayfanızda görünen ve aşağıdaki yapıya sahip yönergeler kümesini tanımlayan parametreler sağlar:

"instructionSteps": [
    {
        "title": "",
        "description": "",
        "instructions": [
        {
            "type": "",
            "parameters": {}
        }
        ],
        "innerSteps": {}
    }
]
Dizi Özelliği Zorunlu Türü Açıklama
başlık String Yönergeleriniz için bir başlık tanımlar.
Açıklama String Yönergeleriniz için anlamlı bir açıklama tanımlar.
innerSteps Dizi İç yönerge adımlarından oluşan bir dizi tanımlar.
Talimat -ları True Yönergeler dizisi Belirli bir parametre türünün yönerge dizisini tanımlar.

yönergeler

Çeşitli parametreler ve daha fazla yönergeSteps'i gruplar halinde iç içe yerleştirme özelliğiyle bir yönerge grubu görüntüler. Burada tanımlanan parametreler karşılık gelir

Tür Dizi özelliği Açıklama
OAuthForm OAuthForm OAuth ile bağlanma
Metin Kutusu Metin Kutusu Bu, ile eşleştirildi ConnectionToggleButton. Kullanılabilir 4 tür vardır:
  • password
  • text
  • number
  • email
    		•
    ConnectionToggleButton ConnectionToggleButton Yer tutucu parametreler aracılığıyla sağlanan bağlantı bilgilerine göre DCR'nin dağıtımını tetikleyin. Aşağıdaki parametreler desteklenir:
  • name :zorunlu
  • disabled
  • isPrimary
  • connectLabel
  • disconnectLabel
    		•
    CopyableLabel CopyableLabel Sonunda kopyala düğmesi bulunan bir metin alanı gösterir. Düğme seçildiğinde, alanın değeri kopyalanır.
    InfoMessage InfoMessage Satır içi bilgi iletisi tanımlar.
    InstructionStepsGroup InstructionStepsGroup İsteğe bağlı olarak genişletilmiş veya daraltılabilir bir yönerge grubunu ayrı bir yönergeler bölümünde görüntüler.
    InstallAgent InstallAgent Çeşitli yükleme gereksinimlerini yerine getirmek için Azure'ın diğer bölümlerine bir bağlantı görüntüler.

    OAuthForm

    Bu bileşen, türün OAuth2 veri bağlayıcısı şablonunun authözelliğinde mevcut olmasını gerektirir.

    "instructions": [
{
  "type": "OAuthForm",
  "parameters": {
    "clientIdLabel": "Client ID",
    "clientSecretLabel": "Client Secret",
    "connectButtonLabel": "Connect",
    "disconnectButtonLabel": "Disconnect"
  }          
}
]

    Metin Kutusu

    Aşağıda türüne ilişkin bazı örnekler verilmiştir Textbox . Bu örnekler, Kodsuz Bağlayıcı Platformu için Veri bağlayıcıları başvurusundaki örnek auth bölümde kullanılan parametrelere karşılık gelir. 4 türün her birinde , placeholderve namebulunurlabel.

    "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

    Örnek:

    Alandaki değeri kopyala düğmesinin ekran görüntüsü.

    Örnek kod:

    {
    "parameters": {
        "fillWith": [
            "WorkspaceId",
            "PrimaryKey"
            ],
        "label": "Here are some values you'll need to proceed.",
        "value": "Workspace is {0} and PrimaryKey is {1}"
    },
    "type": "CopyableLabel"
}
    Dizi Değeri Zorunlu Türü Açıklama
    fillWith SABIT LISTESI Yer tutucuyu doldurmak için kullanılan ortam değişkenleri dizisi. Birden çok yer tutucuyu virgülle ayırın. Örneğin: {0},{1}

    Desteklenen değerler: workspaceId, workspaceName, primaryKey, MicrosoftAwsAccount, subscriptionId
    etiket Doğru String Metin kutusunun üzerindeki etiketin metnini tanımlar.
    value Doğru String Metin kutusunda görüntülenecek değeri tanımlar, yer tutucuları destekler.
    Satır Satırlar Kullanıcı arabirimi alanındaki satırları tanımlar. Varsayılan olarak 1 olarak ayarlayın.
    wideLabel Boolean Uzun dizeler için geniş bir etiket belirler. Varsayılan olarak olarak olarak falseayarlayın.

    InfoMessage

    Satır içi bilgi iletisi örneği aşağıda verilmişti:

    Satır içi bilgi iletisinin ekran görüntüsü.

    Buna karşılık, aşağıdaki görüntüde satır içi olmayan bir bilgi iletisi gösterilir:

    Satır içi olmayan bir bilgi iletisinin ekran görüntüsü.

    Dizi Değeri Type Açıklama
    text String İletide görüntülenecek metni tanımlayın.
    Görünür Boolean İletinin görüntülenip görüntülenmeyeceğini belirler.
    Satır içi Boolean Bilgi iletisinin nasıl görüntüleneceğini belirler.

    - true: (Önerilen) Yönergelere eklenmiş bilgi iletisini gösterir.
    - false: Mavi arka plan ekler.

    InstructionStepsGroup

    Aşağıda genişletilebilir yönerge grubu örneği verilmiştir:

    Genişletilebilir, ek yönerge grubunun ekran görüntüsü.

    Dizi Değeri Zorunlu Türü Açıklama
    başlık Doğru String Yönerge adımının başlığını tanımlar.
    Açıklama String İsteğe bağlı açıklayıcı metin.
    canCollapseAllSections Boolean Bölümün daraltılabilir bir akordeon olup olmadığını belirler.
    noFxPadding Boolean ise true, alandan tasarruf etmek için yükseklik doldurmasını azaltır.
    Genişletilmiş Boolean ise true, varsayılan olarak genişletilmiş olarak gösterilir.

    Ayrıntılı bir örnek için bkz. Windows DNS bağlayıcısı için yapılandırma JSON'ı.

    InstallAgent

    Bazı InstallAgent türleri düğme olarak, diğerleri bağlantı olarak görünür. Aşağıda her ikisine de örnek verilmiştir:

    Düğme olarak eklenen bir bağlantının ekran görüntüsü.

    Satır içi metin olarak eklenen bir bağlantının ekran görüntüsü.

    Dizi Değerleri Zorunlu Türü Açıklama
    linkType Doğru SABIT LISTESI Bağlantı türünü aşağıdaki değerlerden biri olarak belirler:

    InstallAgentOnWindowsVirtualMachine
    InstallAgentOnWindowsNonAzure
    InstallAgentOnLinuxVirtualMachine
    InstallAgentOnLinuxNonAzure
    OpenSyslogSettings
    OpenCustomLogsSettings
    OpenWaf
    OpenAzureFirewall OpenMicrosoftAzureMonitoring
    OpenFrontDoors
    OpenCdnProfile
    AutomaticDeploymentCEF
    OpenAzureInformationProtection
    OpenAzureActivityLog
    OpenIotPricingModel
    OpenPolicyAssignment
    OpenAllAssignmentsBlade
    OpenCreateDataCollectionRule
    policyDefinitionGuid linkType kullanılırken OpenPolicyAssignment True. String İlke tabanlı bağlayıcılar için yerleşik ilke tanımının GUID'sini tanımlar.
    assignMode SABIT LISTESI İlke tabanlı bağlayıcılar için, atama modunu aşağıdaki değerlerden biri olarak tanımlar: Initiative, Policy
    dataCollectionRuleType SABIT LISTESI DCR tabanlı bağlayıcılar için, veri toplama kuralı türünün türünü veya ForwardEventolarak SecurityEventtanımlar.

    Örnek veri bağlayıcısı tanımı

    Aşağıdaki örnek, veri bağlayıcısı tanımı API'sini Oluştur veya Güncelleştir ile kullanmak üzere bu makalede JSON gövde biçimi olarak tanımlanan bileşenlerin bazılarını bir araya getirir.

    Diğer CCP veri bağlayıcılarını gözden geçirme hakkında daha fazla örnek connectorUiConfig için. Eski CCP kullanan bağlayıcılar bile kullanıcı arabirimi oluşturmaya yönelik geçerli örneklere sahiptir.

    {
    "kind": "Customizable",
    "properties": {
        "connectorUiConfig": {
          "title": "Example CCP 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"
                  }
                }
              ]
            }
          ]
        }
    }
}