Data Connectors - Connect

Служба:

Sentinel

Версия API:

2025-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=2025-01-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataConnectorId	path	True	string	Идентификатор соединителя
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
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.
clientSecret	string	Секрет клиента приложения OAuth 2.0.
dataCollectionEndpoint	string	Используется в соединителе журналов версии 2. Представляет конечную точку приема данных в log analytics.
dataCollectionRuleImmutableId	string	Используется в соединителе журналов версии 2. Неизменяемый идентификатор правила сбора данных, правило определяет назначение преобразования и данных.
kind	ConnectAuthKind	Тип проверки подлинности, используемый для опроса данных
outputStream	string	Используется в соединителе журналов версии 2. Поток, в который мы отправляем данные, это имя потоковых данных, определенных в DCR.
password	string	Пароль пользователя на сервере журнала аудита.
requestConfigUserInputValues	object[]
userName	string	Имя пользователя на сервере журнала аудита.

Ответы

Имя	Тип	Описание
200 OK		ОК, операция успешно завершена
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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=2025-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=2025-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	Представляет соединитель данных опроса данных без кода.

CloudError

Структура ответа на ошибки.

Имя	Тип	Описание
error	CloudErrorBody	Данные об ошибках

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

ConnectAuthKind

Тип проверки подлинности, используемый для опроса данных

Имя	Тип	Описание
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Представляет соединитель данных опроса данных без кода.

Имя	Тип	Описание
apiKey	string	Ключ API сервера аудита.
authorizationCode	string	Код авторизации, используемый в потоке кода OAuth 2.0 для выдачи маркера.
clientId	string	Идентификатор клиента приложения OAuth 2.0.
clientSecret	string	Секрет клиента приложения OAuth 2.0.
dataCollectionEndpoint	string	Используется в соединителе журналов версии 2. Представляет конечную точку приема данных в log analytics.
dataCollectionRuleImmutableId	string	Используется в соединителе журналов версии 2. Неизменяемый идентификатор правила сбора данных, правило определяет назначение преобразования и данных.
kind	ConnectAuthKind	Тип проверки подлинности, используемый для опроса данных
outputStream	string	Используется в соединителе журналов версии 2. Поток, в который мы отправляем данные, это имя потоковых данных, определенных в DCR.
password	string	Пароль пользователя на сервере журнала аудита.
requestConfigUserInputValues	object[]
userName	string	Имя пользователя на сервере журнала аудита.