Aracılığıyla paylaş


Data Connector Definitions - Create Or Update

Veri bağlayıcısı tanımını oluşturur veya güncelleştirir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
dataConnectorDefinitionName
path True

string

pattern: ^[a-z0-9A-Z-_]*$

Veri bağlayıcısı tanımı adı.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.

subscriptionId
path True

string (uuid)

Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.

workspaceName
path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

Çalışma alanının adı.

api-version
query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

CustomizableConnectorDefinition

'Özelleştirilebilir' türü için bağlayıcı tanımı.

Name Gerekli Tür Description
kind True string:

Customizable

Veri bağlayıcısı türü

properties.connectorUiConfig True

CustomizableConnectorUiConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

etag

string

Azure kaynağının etag'i

properties.connectionsConfig

CustomizableConnectionsConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

properties.createdTimeUtc

string (date-time)

Bağlayıcı tanımının oluşturulma tarihini UTC biçiminde alır veya ayarlar.

properties.lastModifiedUtc

string (date-time)

Bağlayıcı tanımının son değiştirilme tarihini UTC biçiminde alır veya ayarlar.

Yanıtlar

Name Tür Description
200 OK DataConnectorDefinition:

CustomizableConnectorDefinition

Updated

201 Created DataConnectorDefinition:

CustomizableConnectorDefinition

Oluşturuldu

Other Status Codes

CloudError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create data connector definition

Örnek isteği

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2025-09-01

{
  "kind": "Customizable",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "connectorUiConfig": {
      "title": "GitHub Enterprise Audit Log",
      "publisher": "GitHub",
      "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.",
      "graphQueries": [
        {
          "metricName": "Total events received",
          "legend": "GitHub audit log events",
          "baseQuery": "GitHubAuditLogPolling_CL"
        }
      ],
      "dataTypes": [
        {
          "name": "GitHubAuditLogPolling_CL",
          "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
      ],
      "connectivityCriteria": [
        {
          "type": "IsConnectedQuery",
          "value": [
            "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
          ]
        }
      ],
      "availability": {
        "status": 1,
        "isPreview": false
      },
      "permissions": {
        "resourceProvider": [
          {
            "provider": "Microsoft.OperationalInsights/workspaces",
            "permissionsDisplayText": "read and write permissions are required.",
            "providerDisplayName": "Workspace",
            "scope": "Workspace",
            "requiredPermissions": {
              "write": true,
              "read": false,
              "delete": false,
              "action": false
            }
          }
        ],
        "customs": [
          {
            "name": "GitHub API personal token Key",
            "description": "You need access to GitHub personal token, the key should have 'admin:org' scope"
          }
        ]
      },
      "instructionSteps": [
        {
          "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel",
          "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key",
          "instructions": [
            {
              "type": "OAuthForm",
              "parameters": {
                "clientIdLabel": "Client ID",
                "clientSecretLabel": "Client Secret",
                "connectButtonLabel": "Connect",
                "disconnectButtonLabel": "Disconnect"
              }
            }
          ]
        }
      ]
    }
  }
}

Örnek yanıt

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
  "kind": "Customizable",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "connectorUiConfig": {
      "title": "GitHub Enterprise Audit Log",
      "publisher": "GitHub",
      "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.",
      "graphQueries": [
        {
          "metricName": "Total events received",
          "legend": "GitHub audit log events",
          "baseQuery": "GitHubAuditLogPolling_CL"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "dataTypes": [
        {
          "name": "GitHubAuditLogPolling_CL",
          "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
      ],
      "connectivityCriteria": [
        {
          "type": "IsConnectedQuery",
          "value": [
            "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
          ]
        }
      ],
      "availability": {
        "status": 1,
        "isPreview": false
      },
      "permissions": {
        "resourceProvider": [
          {
            "provider": "Microsoft.OperationalInsights/workspaces",
            "permissionsDisplayText": "read and write permissions are required.",
            "providerDisplayName": "Workspace",
            "scope": "Workspace",
            "requiredPermissions": {
              "write": true,
              "read": false,
              "delete": false,
              "action": false
            }
          }
        ],
        "customs": [
          {
            "name": "GitHub API personal token Key",
            "description": "You need access to GitHub personal token, the key should have 'admin:org' scope"
          }
        ]
      },
      "instructionSteps": [
        {
          "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel",
          "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key",
          "instructions": [
            {
              "type": "OAuthForm",
              "parameters": {
                "clientIdLabel": "Client ID",
                "clientSecretLabel": "Client Secret",
                "connectButtonLabel": "Connect",
                "disconnectButtonLabel": "Disconnect"
              }
            }
          ]
        }
      ]
    }
  }
}
{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
  "kind": "Customizable",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "connectorUiConfig": {
      "title": "GitHub Enterprise Audit Log",
      "publisher": "GitHub",
      "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.",
      "graphQueries": [
        {
          "metricName": "Total events received",
          "legend": "GitHub audit log events",
          "baseQuery": "GitHubAuditLogPolling_CL"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "dataTypes": [
        {
          "name": "GitHubAuditLogPolling_CL",
          "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
      ],
      "connectivityCriteria": [
        {
          "type": "IsConnectedQuery",
          "value": [
            "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
          ]
        }
      ],
      "availability": {
        "status": 1,
        "isPreview": false
      },
      "permissions": {
        "resourceProvider": [
          {
            "provider": "Microsoft.OperationalInsights/workspaces",
            "permissionsDisplayText": "read and write permissions are required.",
            "providerDisplayName": "Workspace",
            "scope": "Workspace",
            "requiredPermissions": {
              "write": true,
              "read": false,
              "delete": false,
              "action": false
            }
          }
        ],
        "customs": [
          {
            "name": "GitHub API personal token Key",
            "description": "You need access to GitHub personal token, the key should have 'admin:org' scope"
          }
        ]
      },
      "instructionSteps": [
        {
          "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel",
          "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key",
          "instructions": [
            {
              "type": "OAuthForm",
              "parameters": {
                "clientIdLabel": "Client ID",
                "clientSecretLabel": "Client Secret",
                "connectButtonLabel": "Connect",
                "disconnectButtonLabel": "Disconnect"
              }
            }
          ]
        }
      ]
    }
  }
}

Tanımlar

Name Description
CloudError

Hata yanıt yapısı.

CloudErrorBody

Hata ayrıntıları.

ConnectivityCriterion

Konektörün bağlı olup olmadığını belirlediğimiz kriterler. Örneğin, beklenen veri türünün akıp akmadığını denetlemek için bir KQL sorgusu kullanın.

ConnectorDataType

Veri türünün çalışma alanında en son ne zaman alındığını belirten bir sorgu da dahil olmak üzere bağlayıcı tarafından oluşturulan veri türü.

ConnectorDefinitionsAvailability

Konektörün müşterilere maruz kalma durumu.

ConnectorDefinitionsPermissions

Bağlayıcı için gerekli İzinler.

ConnectorDefinitionsResourceProvider

Kaynak sağlayıcısı ayrıntıları, kullanıcının bağlantı oluşturması için gerekli izinleri içerir. Kullanıcı, belirtilen kaynak sağlayıcısına karşı belirtilen kapsamda ProviderPermissionsScope gerekli izinlere (Okuma\Yazma, ..) sahip olmalıdır.

createdByType

Kaynağı oluşturan kimliğin türü.

CustomizableConnectionsConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

CustomizableConnectorDefinition

'Özelleştirilebilir' türü için bağlayıcı tanımı.

CustomizableConnectorUiConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

CustomPermissionDetails

Bağlayıcı için gereken Özel izinler.

DataConnectorDefinitionKind

Veri bağlayıcısı tanımlarının türü

GraphQuery

Zaman içinde çalışma alanına gelen veri hacmini gösteren grafik sorgusu.

InstructionStep

Bağlayıcıyı etkinleştirmek için talimat adımları.

InstructionStepDetails

Yönerge adımı ayrıntıları, bağlayıcının Sentinel Portal'daki sayfasındaki Yönerge adımları bölümünde görüntülenecektir.

ProviderPermissionsScope

Bağlantı oluşturabilmek için kullanıcının izinlere sahip olması gereken kapsam.

ResourceProviderRequiredPermissions

ResourceProviders'ta tanımlanan bağlayıcı kaynak sağlayıcısı için gerekli izinler. İzinler hakkında daha fazla bilgi için bkz.<https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">burada</görmek>.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CloudError

Hata yanıt yapısı.

Name Tür Description
error

CloudErrorBody

Hata verileri

CloudErrorBody

Hata ayrıntıları.

Name Tür Description
code

string

Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.

message

string

Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.

ConnectivityCriterion

Konektörün bağlı olup olmadığını belirlediğimiz kriterler. Örneğin, beklenen veri türünün akıp akmadığını denetlemek için bir KQL sorgusu kullanın.

Name Tür Description
type

string

Bağlantı türünü alır veya ayarlar.

value

string[]

Bağlantıyı denetlemek için sorguları alır veya ayarlar.

ConnectorDataType

Veri türünün çalışma alanında en son ne zaman alındığını belirten bir sorgu da dahil olmak üzere bağlayıcı tarafından oluşturulan veri türü.

Name Tür Description
lastDataReceivedQuery

string

Sorguyu, ilgili verilerin çalışma alanında en son ne zaman alındığını gösterecek şekilde alır veya ayarlar.

name

string

Grafikte gösterilecek veri türünün adını alır veya ayarlar.

ConnectorDefinitionsAvailability

Konektörün müşterilere maruz kalma durumu.

Name Tür Description
isPreview

boolean

Bağlayıcının önizleme olup olmadığını gösteren bir değer alır veya ayarlar.

status

integer (int32)

Konektörün müşterilere maruz kalma durumu. Kullanılabilir değerler 0-4 arasındadır (0=Yok, 1=Kullanılabilir, 2=FeatureFlag, 3=Dahili).

ConnectorDefinitionsPermissions

Bağlayıcı için gerekli İzinler.

Name Tür Description
customs

CustomPermissionDetails[]

Kullanıcının bağlantı oluşturması için gereken gümrük izinlerini alır veya ayarlar.

licenses

string[]

Kullanıcının bağlantı oluşturması için gerekli lisansları alır veya ayarlar.

resourceProvider

ConnectorDefinitionsResourceProvider[]

Kullanıcının bağlantı oluşturması için gereken kaynak sağlayıcı izinlerini alır veya ayarlar.

tenant

string[]

Bağlayıcı için gerekli kiracı izinlerini alır veya ayarlar.

ConnectorDefinitionsResourceProvider

Kaynak sağlayıcısı ayrıntıları, kullanıcının bağlantı oluşturması için gerekli izinleri içerir. Kullanıcı, belirtilen kaynak sağlayıcısına karşı belirtilen kapsamda ProviderPermissionsScope gerekli izinlere (Okuma\Yazma, ..) sahip olmalıdır.

Name Tür Description
permissionsDisplayText

string

İzin açıklama metnini alır veya ayarlar.

provider

string

Sağlayıcı adını alır veya ayarlar.

providerDisplayName

string

İzin sağlayıcısının görünen adını alır veya ayarlar.

requiredPermissions

ResourceProviderRequiredPermissions

ResourceProviders'ta tanımlanan bağlayıcı kaynak sağlayıcısı için gerekli izinler. İzinler hakkında daha fazla bilgi için bkz.<https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">burada</görmek>.

scope

ProviderPermissionsScope

Bağlantı oluşturabilmek için kullanıcının izinlere sahip olması gereken kapsam.

createdByType

Kaynağı oluşturan kimliğin türü.

Değer Description
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

Name Tür Description
templateSpecName

string

Şablon adını alır veya ayarlar. Şablon, bağlayıcı tarafından oluşturulabilen ARM şablonlarını içerir, genellikle dataConnectors ARM şablonları olur.

templateSpecVersion

string

Şablon sürümünü alır veya ayarlar.

CustomizableConnectorDefinition

'Özelleştirilebilir' türü için bağlayıcı tanımı.

Name Tür Description
etag

string

Azure kaynağının etag'i

id

string (arm-id)

Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind string:

Customizable

Veri bağlayıcısı türü

name

string

Kaynağın adı

properties.connectionsConfig

CustomizableConnectionsConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

properties.connectorUiConfig

CustomizableConnectorUiConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

properties.createdTimeUtc

string (date-time)

Bağlayıcı tanımının oluşturulma tarihini UTC biçiminde alır veya ayarlar.

properties.lastModifiedUtc

string (date-time)

Bağlayıcı tanımının son değiştirilme tarihini UTC biçiminde alır veya ayarlar.

systemData

systemData

createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

'Özelleştirilebilir' bağlayıcı tanımı türü için UiConfig.

Name Tür Description
availability

ConnectorDefinitionsAvailability

Konektörün müşterilere maruz kalma durumu.

connectivityCriteria

ConnectivityCriterion[]

Bağlayıcının, bağlayıcının bağlı olup olmadığını denetleme şeklini alır veya ayarlar.

dataTypes

ConnectorDataType[]

Alınan son verileri denetlemek için veri türlerini alır veya ayarlar.

descriptionMarkdown

string

Bağlayıcı açıklamasını markdown biçiminde alır veya ayarlar.

graphQueries

GraphQuery[]

Zaman içindeki geçerli veri hacmini göstermek için grafik sorgularını alır veya ayarlar.

id

string

Özel bağlayıcı kimliğini alır veya ayarlar. isteğe bağlı alan.

instructionSteps

InstructionStep[]

Bağlayıcıyı etkinleştirmek için yönerge adımlarını alır veya ayarlar.

isConnectivityCriteriasMatchSome

boolean

ConnectivityCriteria öğeleri arasında 'OR'(SOME) veya 'AND' kullanılıp kullanılmayacağını belirten bir değer alır veya ayarlar.

logo

string

Bağlayıcıyı Azure Sentinel'in bağlayıcı galerisinde görüntülerken kullanılacak bağlayıcı logosunu alır veya ayarlar. Logo değeri SVG formatında olmalıdır.

permissions

ConnectorDefinitionsPermissions

Bağlayıcı için gerekli İzinler.

publisher

string

Bağlayıcı yayımcı adını alır veya ayarlar.

title

string

Bağlayıcı blade başlığını alır veya ayarlar.

CustomPermissionDetails

Bağlayıcı için gereken Özel izinler.

Name Tür Description
description

string

Özel izinler açıklamasını alır veya ayarlar.

name

string

Özel izinlerin adını alır veya ayarlar.

DataConnectorDefinitionKind

Veri bağlayıcısı tanımlarının türü

Değer Description
Customizable

GraphQuery

Zaman içinde çalışma alanına gelen veri hacmini gösteren grafik sorgusu.

Name Tür Description
baseQuery

string

Grafik için temel sorguyu alır veya ayarlar. Temel sorgu, zaman içinde hacmi ölçen bir KQL sorgusu ile Sentinel UI infra tarafından sarmalanır.

legend

string

Grafiğin göstergesini alır veya ayarlar.

metricName

string

Sorgunun denetlediği ölçüm adını alır veya ayarlar. Örneğin: "Toplam veri alımı".

InstructionStep

Bağlayıcıyı etkinleştirmek için talimat adımları.

Name Tür Description
description

string

Yönerge adımı açıklamasını alır veya ayarlar.

innerSteps

InstructionStep[]

İç yönerge adımları ayrıntılarını alır veya ayarlar. Örneğin: talimat adımı 1, dahili talimat adımlarını içerebilir: [talimat adımı 1.1, talimat adımı 1.2].

instructions

InstructionStepDetails[]

Yönerge adımı ayrıntılarını alır veya ayarlar.

title

string

Yönerge adımı başlığını alır veya ayarlar.

InstructionStepDetails

Yönerge adımı ayrıntıları, bağlayıcının Sentinel Portal'daki sayfasındaki Yönerge adımları bölümünde görüntülenecektir.

Name Tür Description
parameters

object

Komut türü parametre ayarlarını alır veya ayarlar.

type

string

Yönerge türü adını alır veya ayarlar.

ProviderPermissionsScope

Bağlantı oluşturabilmek için kullanıcının izinlere sahip olması gereken kapsam.

Değer Description
Subscription
ResourceGroup
Workspace

ResourceProviderRequiredPermissions

ResourceProviders'ta tanımlanan bağlayıcı kaynak sağlayıcısı için gerekli izinler. İzinler hakkında daha fazla bilgi için bkz.<https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">burada</görmek>.

Name Tür Description
action

boolean

İznin özel eylemler (POST) olup olmadığını belirten bir değer alır veya ayarlar.

delete

boolean

İznin silme eylemi (DELETE) olup olmadığını belirten bir değer alır veya ayarlar.

read

boolean

İznin okuma eylemi (GET) olup olmadığını belirten bir değer alır veya ayarlar.

write

boolean

İznin yazma eylemi (PUT veya PATCH) olup olmadığını belirten bir değer alır veya ayarlar.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string (date-time)

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string (date-time)

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimlik türü.