共用方式為

Data Connectors - Connect

  • 參考
服務:
Sentinel
API 版本:
2024-10-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-10-01-preview

URI 參數

名稱 位於 必要 類型 Description
dataConnectorId
 path True

string

連接器標識碼
resourceGroupName
 path True

string

資源群組的名稱。 名稱不區分大小寫。
subscriptionId
 path True

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。
workspaceName
 path True

string

工作區的名稱。

Regex 模式: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

要用於這項作業的 API 版本。

要求本文

名稱 類型 Description
apiKey

string

稽核伺服器的 API 金鑰。
authorizationCode

string

OAuth 2.0 程式代碼流程中用來發出令牌的授權碼。
clientId

string

OAuth 2.0 應用程式的用戶端識別碼。
clientSecret

string

OAuth 2.0 應用程式的客戶端密碼。
dataCollectionEndpoint

string

用於 v2 記錄連接器。 表示記錄分析中的數據收集擷取端點。
dataCollectionRuleImmutableId

string

用於 v2 記錄連接器。 數據收集規則不可變標識碼，規則會定義轉換和數據目的地。
kind

ConnectAuthKind

用來輪詢數據的驗證種類
outputStream

string

用於 v2 記錄連接器。 我們要將數據傳送至的數據流，這是 DCR 中定義的 streamDeclarations 名稱。
password

string

稽核記錄伺服器中的用戶密碼。
requestConfigUserInputValues

object[]

userName

string

稽核記錄伺服器中的用戶名稱。

回應

名稱 類型 Description
200 OK

確定，作業已順利完成
Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Connect an APIPolling data connector
Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

範例要求

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-10-01-preview

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

範例回覆

狀態碼:
200

Connect an APIPolling V2 logs data connector

範例要求

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-10-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

定義

名稱 Description
CloudError

錯誤回應結構。
CloudErrorBody

錯誤詳細數據。
ConnectAuthKind

用來輪詢數據的驗證種類
DataConnectorConnectBody

表示無程式代碼 API 輪詢數據連接器。

CloudError

錯誤回應結構。

名稱 類型 Description
error

CloudErrorBody

錯誤數據

CloudErrorBody

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
message

string

描述錯誤的訊息，適用於在使用者介面中顯示。

ConnectAuthKind

用來輪詢數據的驗證種類

名稱 類型 Description
APIKey

string

Basic

string

OAuth2

string

DataConnectorConnectBody

表示無程式代碼 API 輪詢數據連接器。

名稱 類型 Description
apiKey

string

稽核伺服器的 API 金鑰。
authorizationCode

string

OAuth 2.0 程式代碼流程中用來發出令牌的授權碼。
clientId

string

OAuth 2.0 應用程式的用戶端識別碼。
clientSecret

string

OAuth 2.0 應用程式的客戶端密碼。
dataCollectionEndpoint

string

用於 v2 記錄連接器。 表示記錄分析中的數據收集擷取端點。
dataCollectionRuleImmutableId

string

用於 v2 記錄連接器。 數據收集規則不可變標識碼，規則會定義轉換和數據目的地。
kind

ConnectAuthKind

用來輪詢數據的驗證種類
outputStream

string

用於 v2 記錄連接器。 我們要將數據傳送至的數據流，這是 DCR 中定義的 streamDeclarations 名稱。
password

string

稽核記錄伺服器中的用戶密碼。
requestConfigUserInputValues

object[]

userName

string

稽核記錄伺服器中的用戶名稱。