Data Connectors - Connect

サービス:

Sentinel

API バージョン:

2024-01-01-preview

データ コネクタを接続します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/connect?api-version=2024-01-01-preview

URI パラメーター

名前	/	必須	型	説明
dataConnectorId	path	True	string	コネクタ ID
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 バージョン。

要求本文

名前	型	説明
apiKey	string	監査サーバーの API キー。
authorizationCode	string	トークンを発行するために OAuth 2.0 コード フローで使用される承認コード。
clientId	string	OAuth 2.0 アプリケーションのクライアント ID。
clientSecret	string	OAuth 2.0 アプリケーションのクライアント シークレット。
dataCollectionEndpoint	string	v2 ログ コネクタで使用されます。 ログ分析のデータ収集インジェスト エンドポイントを表します。
dataCollectionRuleImmutableId	string	v2 ログ コネクタで使用されます。 データ収集ルールの不変 ID。ルールは変換先とデータ変換先を定義します。
kind	ConnectAuthKind	データのポーリングに使用される認証の種類
outputStream	string	v2 ログ コネクタで使用されます。 データを送信するストリーム。これは DCR で定義されている streamDeclarations の名前です。
password	string	監査ログ サーバーのユーザー パスワード。
requestConfigUserInputValues	object[]
userName	string	監査ログ サーバーのユーザー名。

応答

名前	型	説明
200 OK		OK、操作が正常に完了しました
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8/connect?api-version=2024-01-01-preview

{
  "kind": "APIKey",
  "apiKey": "123456789",
  "requestConfigUserInputValues": [
    {
      "displayText": "Organization Name",
      "placeHolderName": "{{placeHolder1}}",
      "placeHolderValue": "somePlaceHolderValue",
      "requestObjectKey": "apiEndpoint"
    }
  ]
}

応答のサンプル

状態コード:

200

Connect an APIPolling V2 logs data connector

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8/connect?api-version=2024-01-01-preview

{
  "kind": "APIKey",
  "apiKey": "123456789",
  "dataCollectionEndpoint": "https://test.eastus.ingest.monitor.azure.com",
  "dataCollectionRuleImmutableId": "dcr-34adsj9o7d6f9de204478b9cgb43b631",
  "outputStream": "Custom-MyTableRawData",
  "requestConfigUserInputValues": [
    {
      "displayText": "Organization Name",
      "placeHolderName": "{{placeHolder1}}",
      "placeHolderValue": "somePlaceHolderValue",
      "requestObjectKey": "apiEndpoint"
    }
  ]
}

応答のサンプル

状態コード:

200

定義

名前	説明
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
ConnectAuthKind	データのポーリングに使用される認証の種類
DataConnectorConnectBody	コードレス API ポーリング データ コネクタを表します。

CloudError

エラー応答の構造。

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

CloudErrorBody

エラーの詳細。

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

ConnectAuthKind

データのポーリングに使用される認証の種類

名前	型	説明
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

コードレス API ポーリング データ コネクタを表します。

名前	型	説明
apiKey	string	監査サーバーの API キー。
authorizationCode	string	トークンを発行するために OAuth 2.0 コード フローで使用される承認コード。
clientId	string	OAuth 2.0 アプリケーションのクライアント ID。
clientSecret	string	OAuth 2.0 アプリケーションのクライアント シークレット。
dataCollectionEndpoint	string	v2 ログ コネクタで使用されます。 ログ分析のデータ収集インジェスト エンドポイントを表します。
dataCollectionRuleImmutableId	string	v2 ログ コネクタで使用されます。 データ収集ルールの不変 ID。ルールは変換先とデータ変換先を定義します。
kind	ConnectAuthKind	データのポーリングに使用される認証の種類
outputStream	string	v2 ログ コネクタで使用されます。 データを送信するストリーム。これは DCR で定義されている streamDeclarations の名前です。
password	string	監査ログ サーバーのユーザー パスワード。
requestConfigUserInputValues	object[]
userName	string	監査ログ サーバーのユーザー名。