Data Connector Definitions - Get

リファレンス

サービス:: Sentinel

API バージョン:: 2024-01-01-preview

データコネクタ定義を取得します。

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

URI パラメーター

名前	/	必須	型	説明
dataConnectorDefinitionName	path	True	string	データコネクタ定義名。正規表現パターン: `^[a-z0-9A-Z-_]*$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。正規表現パターン: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Success
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get customize data connector definition

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12?api-version=2024-01-01-preview

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityInsights.Models;
using Azure.ResourceManager.SecurityInsights;

// Generated from example definition: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-01-01-preview/examples/dataConnectorDefinitions/GetCustomizableDataConnectoeDefinitionById.json
// this example is just showing the usage of "DataConnectorDefinitions_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this OperationalInsightsWorkspaceSecurityInsightsResource created on azure
// for more information of creating OperationalInsightsWorkspaceSecurityInsightsResource, please refer to the document of OperationalInsightsWorkspaceSecurityInsightsResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
ResourceIdentifier operationalInsightsWorkspaceSecurityInsightsResourceId = OperationalInsightsWorkspaceSecurityInsightsResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
OperationalInsightsWorkspaceSecurityInsightsResource operationalInsightsWorkspaceSecurityInsights = client.GetOperationalInsightsWorkspaceSecurityInsightsResource(operationalInsightsWorkspaceSecurityInsightsResourceId);

// get the collection of this SecurityInsightsDataConnectorDefinitionResource
SecurityInsightsDataConnectorDefinitionCollection collection = operationalInsightsWorkspaceSecurityInsights.GetSecurityInsightsDataConnectorDefinitions();

// invoke the operation
string dataConnectorDefinitionName = "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12";
NullableResponse<SecurityInsightsDataConnectorDefinitionResource> response = await collection.GetIfExistsAsync(dataConnectorDefinitionName);
SecurityInsightsDataConnectorDefinitionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SecurityInsightsDataConnectorDefinitionData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "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"
        }
      ],
      "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"
              }
            }
          ]
        }
      ]
    },
    "connectionsConfig": {
      "templateSpecName": "templateNameMock",
      "templateSpecVersion": "1.0.0"
    }
  }
}

定義

名前	説明
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
ConnectivityCriterion	コネクタが接続されているかどうかを判断する基準。たとえば、KQL クエリを使用して、予想されるデータ型がフローしているかどうかをチェックします。
ConnectorDataType	コネクタによって作成されるデータ型。ワークスペースでデータ型が最後に受信されたのがいつだったかを示すクエリも含まれます。
ConnectorDefinitionsAvailability	顧客へのコネクタの露出状態。
ConnectorDefinitionsPermissions	コネクタに必要なアクセス許可。
ConnectorDefinitionsResourceProvider	リソースプロバイダーの詳細には、ユーザーが接続を作成するために必要なアクセス許可が含まれます。ユーザーは、指定したリソースプロバイダーに対して、指定されたスコープ ProviderPermissionsScope に必要なアクセス許可 (Read\Write, ..) を持っている必要があります。
createdByType	リソースを作成した ID の種類。
CustomizableConnectionsConfig	'カスタマイズ可能' コネクタ定義の種類の UiConfig。
CustomizableConnectorDefinition	種類 'カスタマイズ可能' のコネクタ定義。
CustomizableConnectorUiConfig	'カスタマイズ可能' コネクタ定義の種類の UiConfig。
CustomPermissionDetails	コネクタに必要なカスタムアクセス許可。
DataConnectorDefinitionKind	データコネクタ定義の種類
GraphQuery	時間の経過と同時にワークスペースに到着するデータの量を示すグラフクエリ。
InstructionStep	コネクタを有効にする手順。
InstructionStepDetails	Sentinel Portal のコネクタのページの [手順ステップ] セクションに表示される命令ステップの詳細。
ProviderPermissionsScope	接続を作成できるようにするために、ユーザーがアクセス許可を持つ必要があるスコープ。
ResourceProviderRequiredPermissions	ResourceProviders で定義するコネクタリソースプロバイダーに必要なアクセス許可。アクセス許可の詳細については、こちらを参照してください。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

エラー応答の構造。

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

CloudErrorBody

エラーの詳細。

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

ConnectivityCriterion

コネクタが接続されているかどうかを判断する基準。たとえば、KQL クエリを使用して、予想されるデータ型がフローしているかどうかをチェックします。

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

ConnectorDataType

コネクタによって作成されるデータ型。ワークスペースでデータ型が最後に受信されたのがいつだったかを示すクエリも含まれます。

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

ConnectorDefinitionsAvailability

顧客へのコネクタの露出状態。

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

ConnectorDefinitionsPermissions

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

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

ConnectorDefinitionsResourceProvider

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

名前	型	説明
permissionsDisplayText	string	アクセス許可の説明テキストを取得または設定します。
provider	string	プロバイダー名を取得または設定します。
providerDisplayName	string	アクセス許可プロバイダーの表示名を取得または設定します。
requiredPermissions	ResourceProviderRequiredPermissions	ResourceProviders で定義するコネクタリソースプロバイダーに必要なアクセス許可。アクセス許可の詳細については、こちらを参照してください。
scope	ProviderPermissionsScope	接続を作成できるようにするために、ユーザーがアクセス許可を持つ必要があるスコープ。

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CustomizableConnectionsConfig

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

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

CustomizableConnectorDefinition

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

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース 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	コネクタ定義の作成日を UTC 形式で取得または設定します。
properties.lastModifiedUtc	string	コネクタ定義の最終更新日を UTC 形式で取得または設定します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

'カスタマイズ可能' コネクタ定義の種類の 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

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

名前	型	説明
description	string	カスタムアクセス許可の説明を取得または設定します。
name	string	カスタムアクセス許可名を取得または設定します。

DataConnectorDefinitionKind

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

名前	型	説明
Customizable	string

GraphQuery

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

名前	型	説明
baseQuery	string	グラフの基本クエリを取得または設定します。ベースクエリは、時間の経過と共にボリュームを測定する KQL クエリを使用して Sentinel UI インフラストラクチャによってラップされます。
legend	string	グラフの凡例を取得または設定します。
metricName	string	クエリがチェックしているメトリック名を取得または設定します。たとえば、'Total data receive' です。

InstructionStep

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

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

InstructionStepDetails

Sentinel Portal のコネクタのページの [手順ステップ] セクションに表示される命令ステップの詳細。

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

ProviderPermissionsScope

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

名前	型	説明
ResourceGroup	string
Subscription	string
Workspace	string

ResourceProviderRequiredPermissions

ResourceProviders で定義するコネクタリソースプロバイダーに必要なアクセス許可。アクセス許可の詳細については、こちらを参照してください。

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

systemData

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

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

次の方法で共有