你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 日志连接器中使用。 表示 Log Analytics 中的数据收集引入终结点。
dataCollectionRuleImmutableId	string	在 v2 日志连接器中使用。 数据收集规则不可变 ID，该规则定义转换和数据目标。
kind	ConnectAuthKind	用于轮询数据的身份验证类型
outputStream	string	在 v2 日志连接器中使用。 要向其发送数据的流，这是 DCR 中定义的 streamDeclarations 的名称。
password	string	审核日志服务器中的用户密码。
requestConfigUserInputValues	object[]
userName	string	审核日志服务器中的用户名。

响应

名称	类型	说明
200 OK		确定，操作已成功完成
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 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 日志连接器中使用。 表示 Log Analytics 中的数据收集引入终结点。
dataCollectionRuleImmutableId	string	在 v2 日志连接器中使用。 数据收集规则不可变 ID，该规则定义转换和数据目标。
kind	ConnectAuthKind	用于轮询数据的身份验证类型
outputStream	string	在 v2 日志连接器中使用。 要向其发送数据的流，这是 DCR 中定义的 streamDeclarations 的名称。
password	string	审核日志服务器中的用户密码。
requestConfigUserInputValues	object[]
userName	string	审核日志服务器中的用户名。