Data Connector Definitions - Create Or Update

サービス:: Sentinel

API バージョン:: 2025-09-01

データ・コネクター定義を作成または更新します。

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 パラメーター

名前	/	必須	型	説明
dataConnectorDefinitionName	path	True	string pattern: ^[a-z0-9A-Z-_]*$	データ・コネクター定義名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	ワークスペースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

CustomizableConnectorDefinition

種類 'Customizable' のコネクタ定義。

名前	必須	型	説明
kind	True	string: Customizable	データコネクタの種類
properties.connectorUiConfig	True	CustomizableConnectorUiConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
etag		string	Azure リソースの Etag
properties.connectionsConfig		CustomizableConnectionsConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
properties.createdTimeUtc		string (date-time)	コネクタ定義の作成日を UTC 形式で取得または設定します。
properties.lastModifiedUtc		string (date-time)	コネクタ定義の最終更新日を UTC 形式で取得または設定します。

応答

名前	型	説明
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Updated
201 Created	DataConnectorDefinition: CustomizableConnectorDefinition	作成済み
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create data connector definition

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

定義

名前	説明
CloudError	エラー応答構造。
CloudErrorBody	エラーの詳細。
ConnectivityCriterion	コネクタが接続されているかどうかを判断する基準。たとえば、KQL クエリを使用して、予期されるデータ型が流れているかどうかを確認します)。
ConnectorDataType	コネクタによって作成されるデータ型 (そのデータ型がワークスペースで最後に受信された日時を示すクエリを含む)。
ConnectorDefinitionsAvailability	顧客へのコネクタの公開状態。
ConnectorDefinitionsPermissions	コネクタに必要なアクセス許可。
ConnectorDefinitionsResourceProvider	リソースプロバイダーの詳細には、ユーザーが接続を作成するために必要なアクセス許可が含まれます。ユーザーは、指定されたリソースプロバイダーに対して、指定されたスコープ ProviderPermissionsScope で必要なアクセス許可 (Read\Write, ..) を持っている必要があります。
createdByType	リソースを作成した ID の種類。
CustomizableConnectionsConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
CustomizableConnectorDefinition	種類 'Customizable' のコネクタ定義。
CustomizableConnectorUiConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
CustomPermissionDetails	コネクタに必要なカスタム権限。
DataConnectorDefinitionKind	データコネクタ定義の種類
GraphQuery	時間の経過とともにワークスペースに到着するデータの量を示すグラフクエリ。
InstructionStep	コネクタを有効にする手順。
InstructionStepDetails	手順ステップの詳細は、Sentinelポータルのコネクタページの[手順手順]セクションに表示されます。
ProviderPermissionsScope	接続を作成できるようにするために、ユーザーがアクセス許可を持つ必要があるスコープ。
ResourceProviderRequiredPermissions	ResourceProvidersで定義されているコネクタ・リソース・プロバイダーに必要な権限。アクセス許可の詳細については、「 <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format"を参照してください>ここ</参照>。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

Object

エラー応答構造。

名前	型	説明
error	CloudErrorBody	エラーデータ

CloudErrorBody

Object

エラーの詳細。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

ConnectivityCriterion

Object

コネクタが接続されているかどうかを判断する基準。たとえば、KQL クエリを使用して、予期されるデータ型が流れているかどうかを確認します)。

名前	型	説明
type	string	接続の種類を取得または設定します。
value	string[]	接続をチェックするためのクエリを取得または設定します。

ConnectorDataType

Object

コネクタによって作成されるデータ型 (そのデータ型がワークスペースで最後に受信された日時を示すクエリを含む)。

名前	型	説明
lastDataReceivedQuery	string	関連するデータがワークスペースで最後に受信された日時を示すクエリを取得または設定します。
name	string	グラフに表示するデータ型の名前を取得または設定します。

ConnectorDefinitionsAvailability

Object

顧客へのコネクタの公開状態。

名前	型	説明
isPreview	boolean	コネクタがプレビューであるかどうかを示す値を取得または設定します。
status	integer (int32)	顧客へのコネクタの公開状態。使用可能な値は 0 から 4 です (0 = なし、1 = 使用可能、2 = FeatureFlag、3 = 内部)。

ConnectorDefinitionsPermissions

Object

コネクタに必要なアクセス許可。

名前	型	説明
customs	CustomPermissionDetails[]	ユーザーが接続を作成するために必要なカスタム権限を取得または設定します。
licenses	string[]	ユーザーが接続を作成するために必要なライセンスを取得または設定します。
resourceProvider	ConnectorDefinitionsResourceProvider[]	ユーザーが接続を作成するために必要なリソースプロバイダーのアクセス許可を取得または設定します。
tenant	string[]	コネクタに必要なテナントのアクセス許可を取得または設定します。

ConnectorDefinitionsResourceProvider

Object

リソースプロバイダーの詳細には、ユーザーが接続を作成するために必要なアクセス許可が含まれます。ユーザーは、指定されたリソースプロバイダーに対して、指定されたスコープ ProviderPermissionsScope で必要なアクセス許可 (Read\Write, ..) を持っている必要があります。

名前	型	説明
permissionsDisplayText	string	アクセス許可の説明テキストを取得または設定します。
provider	string	プロバイダー名を取得または設定します。
providerDisplayName	string	アクセス許可プロバイダーの表示名を取得または設定します。
requiredPermissions	ResourceProviderRequiredPermissions	ResourceProvidersで定義されているコネクタ・リソース・プロバイダーに必要な権限。アクセス許可の詳細については、「 <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format"を参照してください>ここ</参照>。
scope	ProviderPermissionsScope	接続を作成できるようにするために、ユーザーがアクセス許可を持つ必要があるスコープ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

Object

「カスタマイズ可能」コネクタ定義の種類の UiConfig。

名前	型	説明
templateSpecName	string	テンプレート名を取得または設定します。テンプレートには、コネクタで作成できる ARM テンプレートが含まれており、通常は dataConnectors ARM テンプレートになります。
templateSpecVersion	string	テンプレートのバージョンを取得または設定します。

CustomizableConnectorDefinition

Object

種類 'Customizable' のコネクタ定義。

名前	型	説明
etag	string	Azure リソースの Etag
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: Customizable	データコネクタの種類
name	string	リソースの名前
properties.connectionsConfig	CustomizableConnectionsConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
properties.connectorUiConfig	CustomizableConnectorUiConfig	「カスタマイズ可能」コネクタ定義の種類の UiConfig。
properties.createdTimeUtc	string (date-time)	コネクタ定義の作成日を UTC 形式で取得または設定します。
properties.lastModifiedUtc	string (date-time)	コネクタ定義の最終更新日を UTC 形式で取得または設定します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

Object

「カスタマイズ可能」コネクタ定義の種類の UiConfig。

名前	型	説明
availability	ConnectorDefinitionsAvailability	顧客へのコネクタの公開状態。
connectivityCriteria	ConnectivityCriterion[]	コネクタがコネクタが接続されているかどうかを確認する方法を取得または設定します。
dataTypes	ConnectorDataType[]	最後に受信したデータを確認するデータ型を取得または設定します。
descriptionMarkdown	string	コネクタの説明をマークダウン形式で取得または設定します。
graphQueries	GraphQuery[]	グラフクエリを取得または設定して、時間の経過に伴う現在のデータ量を表示します。
id	string	カスタムコネクタ ID を取得または設定します。オプションのフィールド。
instructionSteps	InstructionStep[]	コネクタを有効にするための手順を取得または設定します。
isConnectivityCriteriasMatchSome	boolean	ConnectivityCriteria 項目間で 'OR'(SOME) または 'AND' を使用するかどうかを示す値を取得または設定します。
logo	string	Azure Sentinel のコネクタのギャラリー内でコネクタを表示するときに使用するコネクタロゴを取得または設定します。ロゴの値は SVG 形式である必要があります。
permissions	ConnectorDefinitionsPermissions	コネクタに必要なアクセス許可。
publisher	string	コネクタの発行元名を取得または設定します。
title	string	コネクタブレードのタイトルを取得または設定します。

CustomPermissionDetails

Object

コネクタに必要なカスタム権限。

名前	型	説明
description	string	カスタム権限の説明を取得または設定します。
name	string	カスタム権限名を取得または設定します。

DataConnectorDefinitionKind

列挙

データコネクタ定義の種類

値	説明
Customizable

GraphQuery

Object

時間の経過とともにワークスペースに到着するデータの量を示すグラフクエリ。

名前	型	説明
baseQuery	string	グラフの基本クエリを取得または設定します。基本クエリは、時間の経過に伴うボリュームを測定する KQL クエリを使用して Sentinel UI インフラストラクチャによってラップされます。
legend	string	グラフの凡例を取得または設定します。
metricName	string	クエリがチェックしているメトリック名を取得または設定します。たとえば、「受信したデータの合計数」などです。

InstructionStep

Object

コネクタを有効にする手順。

名前	型	説明
description	string	命令ステップの説明を取得または設定します。
innerSteps	InstructionStep[]	内部命令ステップの詳細を取得または設定します。たとえば、命令ステップ 1 には、内部命令ステップ [命令ステップ 1.1、命令ステップ 1.2] が含まれる場合があります。
instructions	InstructionStepDetails[]	命令ステップの詳細を取得または設定します。
title	string	命令ステップのタイトルを取得または設定します。

InstructionStepDetails

Object

手順ステップの詳細は、Sentinelポータルのコネクタページの[手順手順]セクションに表示されます。

名前	型	説明
parameters	object	命令型パラメーター設定を取得または設定します。
type	string	命令型名を取得または設定します。

ProviderPermissionsScope

列挙

接続を作成できるようにするために、ユーザーがアクセス許可を持つ必要があるスコープ。

値	説明
Subscription
ResourceGroup
Workspace

ResourceProviderRequiredPermissions

Object

ResourceProvidersで定義されているコネクタ・リソース・プロバイダーに必要な権限。アクセス許可の詳細については、「 <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format"を参照してください>ここ</参照>。

名前	型	説明
action	boolean	アクセス許可がカスタムアクション(POST)であるかどうかを示す値を取得または設定します。
delete	boolean	アクセス許可が削除アクション (DELETE) であるかどうかを示す値を取得または設定します。
read	boolean	アクセス許可が読み取りアクション (GET) であるかどうかを示す値を取得または設定します。
write	boolean	アクセス許可が書き込みアクション (PUT または PATCH) であるかどうかを示す値を取得または設定します。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Data Connector Definitions - Create Or Update

URI パラメーター

要求本文

CustomizableConnectorDefinition

応答

セキュリティ

azure_auth

スコープ

例

Create data connector definition

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

ConnectivityCriterion

ConnectorDataType

ConnectorDefinitionsAvailability

ConnectorDefinitionsPermissions

ConnectorDefinitionsResourceProvider

createdByType

CustomizableConnectionsConfig

CustomizableConnectorDefinition

CustomizableConnectorUiConfig

CustomPermissionDetails

DataConnectorDefinitionKind

GraphQuery

InstructionStep

InstructionStepDetails

ProviderPermissionsScope

ResourceProviderRequiredPermissions

systemData