Bagikan melalui


Data Connector Definitions - Create Or Update

Membuat atau memperbarui definisi konektor data.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
dataConnectorDefinitionName
path True

string

Nama definisi konektor data.

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

resourceGroupName
path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

subscriptionId
path True

string

ID langganan target.

workspaceName
path True

string

Nama ruang kerja.

Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

CustomizableConnectorDefinition

Definisi konektor untuk jenis 'Dapat Disesuaikan'.

Nama Diperlukan Jenis Deskripsi
kind True string:

Customizable

Jenis konektor data

properties.connectorUiConfig True

CustomizableConnectorUiConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

etag

string

Etag sumber daya azure

properties.connectionsConfig

CustomizableConnectionsConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

properties.createdTimeUtc

string

Mendapatkan atau mengatur tanggal pembuatan definisi konektor dalam format UTC.

properties.lastModifiedUtc

string

Mendapatkan atau mengatur definisi konektor tanggal terakhir diubah dalam format UTC.

Respons

Nama Jenis Deskripsi
200 OK DataConnectorDefinition:

CustomizableConnectorDefinition

Diperbarui

201 Created DataConnectorDefinition:

CustomizableConnectorDefinition

Dibuat

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Create data connector definition

Sample Request

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=2024-01-01-preview

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

Sample Response

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

Definisi

Nama Deskripsi
CloudError

Struktur respons kesalahan.

CloudErrorBody

Detail kesalahan.

ConnectivityCriterion

Kriteria tempat kami menentukan apakah konektor tersambung atau tidak. Misalnya, gunakan kueri KQL untuk memeriksa apakah jenis data yang diharapkan mengalir).

ConnectorDataType

Jenis data yang dibuat oleh konektor, termasuk kueri yang ditunjukkan kapan terakhir kali jenis data diterima di ruang kerja.

ConnectorDefinitionsAvailability

Status paparan konektor kepada pelanggan.

ConnectorDefinitionsPermissions

Izin yang diperlukan untuk konektor.

ConnectorDefinitionsResourceProvider

Detail penyedia sumber daya mencakup izin yang diperlukan bagi pengguna untuk membuat koneksi. Pengguna harus memiliki izin yang diperlukan (Read\Write, ..) dalam cakupan yang ditentukan ProviderPermissionsScope terhadap penyedia sumber daya yang ditentukan.

createdByType

Jenis identitas yang membuat sumber daya.

CustomizableConnectionsConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

CustomizableConnectorDefinition

Definisi konektor untuk jenis 'Dapat Disesuaikan'.

CustomizableConnectorUiConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

CustomPermissionDetails

Izin Kustom diperlukan untuk konektor.

DataConnectorDefinitionKind

Jenis definisi konektor data

GraphQuery

Kueri grafik untuk memperlihatkan volume data yang tiba ke ruang kerja dari waktu ke waktu.

InstructionStep

Langkah-langkah instruksi untuk mengaktifkan konektor.

InstructionStepDetails

Detail langkah instruksi, yang akan ditampilkan di bagian Langkah instruksi di halaman konektor di Portal Sentinel.

ProviderPermissionsScope

Cakupan di mana pengguna harus memiliki izin, agar dapat membuat koneksi.

ResourceProviderRequiredPermissions

Izin yang diperlukan untuk penyedia sumber daya konektor yang menentukan di ResourceProviders. Untuk informasi selengkapnya tentang izin, lihat di sini.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

Struktur respons kesalahan.

Nama Jenis Deskripsi
error

CloudErrorBody

Data kesalahan

CloudErrorBody

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.

message

string

Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.

ConnectivityCriterion

Kriteria tempat kami menentukan apakah konektor tersambung atau tidak. Misalnya, gunakan kueri KQL untuk memeriksa apakah jenis data yang diharapkan mengalir).

Nama Jenis Deskripsi
type

string

Mendapatkan atau mengatur jenis konektivitas.

value

string[]

Mendapatkan atau mengatur kueri untuk memeriksa konektivitas.

ConnectorDataType

Jenis data yang dibuat oleh konektor, termasuk kueri yang ditunjukkan kapan terakhir kali jenis data diterima di ruang kerja.

Nama Jenis Deskripsi
lastDataReceivedQuery

string

Mendapatkan atau mengatur kueri untuk menunjukkan kapan data yang relevan terakhir diterima di ruang kerja.

name

string

Mendapatkan atau mengatur nama jenis data untuk ditampilkan dalam grafik.

ConnectorDefinitionsAvailability

Status paparan konektor kepada pelanggan.

Nama Jenis Deskripsi
isPreview

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah konektor adalah pratinjau.

status

integer

Status paparan konektor kepada pelanggan. Nilai yang tersedia adalah 0-4 (0=Tidak Ada, 1=Tersedia, 2=FeatureFlag, 3=Internal).

ConnectorDefinitionsPermissions

Izin yang diperlukan untuk konektor.

Nama Jenis Deskripsi
customs

CustomPermissionDetails[]

Mendapatkan atau mengatur izin kustom yang diperlukan pengguna untuk membuat koneksi.

licenses

string[]

Mendapatkan atau mengatur lisensi yang diperlukan bagi pengguna untuk membuat koneksi.

resourceProvider

ConnectorDefinitionsResourceProvider[]

Mendapatkan atau mengatur izin penyedia sumber daya yang diperlukan pengguna untuk membuat koneksi.

tenant

string[]

Mendapatkan atau mengatur izin penyewa yang diperlukan untuk konektor.

ConnectorDefinitionsResourceProvider

Detail penyedia sumber daya mencakup izin yang diperlukan bagi pengguna untuk membuat koneksi. Pengguna harus memiliki izin yang diperlukan (Read\Write, ..) dalam cakupan yang ditentukan ProviderPermissionsScope terhadap penyedia sumber daya yang ditentukan.

Nama Jenis Deskripsi
permissionsDisplayText

string

Mendapatkan atau mengatur teks deskripsi izin.

provider

string

Mendapatkan atau mengatur nama penyedia.

providerDisplayName

string

Mendapatkan atau mengatur nama tampilan penyedia izin.

requiredPermissions

ResourceProviderRequiredPermissions

Izin yang diperlukan untuk penyedia sumber daya konektor yang menentukan di ResourceProviders. Untuk informasi selengkapnya tentang izin, lihat di sini.

scope

ProviderPermissionsScope

Cakupan di mana pengguna harus memiliki izin, agar dapat membuat koneksi.

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

CustomizableConnectionsConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

Nama Jenis Deskripsi
templateSpecName

string

Mendapatkan atau mengatur nama templat. Templat ini mencakup templat ARM yang dapat dibuat oleh konektor, biasanya templat ARM dataConnectors akan dibuat.

templateSpecVersion

string

Mendapatkan atau mengatur versi templat.

CustomizableConnectorDefinition

Definisi konektor untuk jenis 'Dapat Disesuaikan'.

Nama Jenis Deskripsi
etag

string

Etag sumber daya azure

id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind string:

Customizable

Jenis konektor data

name

string

Nama sumber daya.

properties.connectionsConfig

CustomizableConnectionsConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

properties.connectorUiConfig

CustomizableConnectorUiConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

properties.createdTimeUtc

string

Mendapatkan atau mengatur tanggal pembuatan definisi konektor dalam format UTC.

properties.lastModifiedUtc

string

Mendapatkan atau mengatur definisi konektor tanggal terakhir diubah dalam format UTC.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

UiConfig untuk jenis definisi konektor 'Dapat disesuaikan'.

Nama Jenis Deskripsi
availability

ConnectorDefinitionsAvailability

Status paparan konektor kepada pelanggan.

connectivityCriteria

ConnectivityCriterion[]

Mendapatkan atau mengatur cara konektor memeriksa apakah konektor tersambung.

dataTypes

ConnectorDataType[]

Mendapatkan atau mengatur jenis data untuk memeriksa data terakhir yang diterima.

descriptionMarkdown

string

Mendapatkan atau mengatur deskripsi konektor dalam format markdown.

graphQueries

GraphQuery[]

Mendapatkan atau mengatur kueri grafik untuk menampilkan volume data saat ini dari waktu ke waktu.

id

string

Mendapatkan atau mengatur id konektor kustom. bidang opsional.

instructionSteps

InstructionStep[]

Mendapatkan atau mengatur langkah-langkah instruksi untuk mengaktifkan konektor.

isConnectivityCriteriasMatchSome

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menggunakan 'OR'(SOME) atau 'AND' antara item ConnectivityCriteria.

logo

string

Mendapatkan atau mengatur logo konektor yang akan digunakan saat menampilkan konektor dalam galeri konektor Azure Sentinel. Nilai logo harus dalam format SVG.

permissions

ConnectorDefinitionsPermissions

Izin yang diperlukan untuk konektor.

publisher

string

Mendapatkan atau mengatur nama penerbit konektor.

title

string

Mendapatkan atau mengatur judul bilah konektor.

CustomPermissionDetails

Izin Kustom diperlukan untuk konektor.

Nama Jenis Deskripsi
description

string

Mendapatkan atau mengatur deskripsi izin kustom.

name

string

Mendapatkan atau mengatur nama izin kustom.

DataConnectorDefinitionKind

Jenis definisi konektor data

Nama Jenis Deskripsi
Customizable

string

GraphQuery

Kueri grafik untuk memperlihatkan volume data yang tiba ke ruang kerja dari waktu ke waktu.

Nama Jenis Deskripsi
baseQuery

string

Mendapatkan atau mengatur kueri dasar untuk grafik. Kueri dasar dibungkus oleh infra antarmuka pengguna Sentinel dengan kueri KQL, yang mengukur volume dari waktu ke waktu.

legend

string

Mendapatkan atau mengatur legenda untuk grafik.

metricName

string

Mendapatkan atau mengatur nama metrik yang diperiksa kueri. Misalnya: 'Total data yang diterima'.

InstructionStep

Langkah-langkah instruksi untuk mengaktifkan konektor.

Nama Jenis Deskripsi
description

string

Mendapatkan atau mengatur deskripsi langkah instruksi.

innerSteps

InstructionStep[]

Mendapatkan atau mengatur detail langkah-langkah instruksi dalam. Contoh Foe: instruksi langkah 1 mungkin berisi langkah-langkah instruksi dalam: [langkah instruksi 1.1, langkah instruksi 1.2].

instructions

InstructionStepDetails[]

Mendapatkan atau mengatur detail langkah instruksi.

title

string

Mendapatkan atau mengatur judul langkah instruksi.

InstructionStepDetails

Detail langkah instruksi, yang akan ditampilkan di bagian Langkah instruksi di halaman konektor di Portal Sentinel.

Nama Jenis Deskripsi
parameters

object

Mendapatkan atau mengatur pengaturan parameter jenis instruksi.

type

string

Mendapatkan atau mengatur nama jenis instruksi.

ProviderPermissionsScope

Cakupan di mana pengguna harus memiliki izin, agar dapat membuat koneksi.

Nama Jenis Deskripsi
ResourceGroup

string

Subscription

string

Workspace

string

ResourceProviderRequiredPermissions

Izin yang diperlukan untuk penyedia sumber daya konektor yang menentukan di ResourceProviders. Untuk informasi selengkapnya tentang izin, lihat di sini.

Nama Jenis Deskripsi
action

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah izin tersebut adalah tindakan kustom (POST).

delete

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah izin tersebut adalah tindakan hapus (DELETE).

read

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah izin adalah tindakan baca (GET).

write

boolean

Mendapatkan atau menetapkan nilai yang menunjukkan apakah izinnya adalah tindakan tulis (PUT atau PATCH).

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir memodifikasi sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.