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	Идентификатор соединителя
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Имя рабочей области.
api-version	query	True	string minLength: 1	Версия 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

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"
    }
  ]
}

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/dataConnectors/ConnectAPIPolling.json
// this example is just showing the usage of "DataConnectors_Connect" 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 SecurityInsightsDataConnectorResource created on azure
// for more information of creating SecurityInsightsDataConnectorResource, please refer to the document of SecurityInsightsDataConnectorResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
string dataConnectorId = "316ec55e-7138-4d63-ab18-90c8a60fd1c8";
ResourceIdentifier securityInsightsDataConnectorResourceId = SecurityInsightsDataConnectorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, dataConnectorId);
SecurityInsightsDataConnectorResource securityInsightsDataConnector = client.GetSecurityInsightsDataConnectorResource(securityInsightsDataConnectorResourceId);

// invoke the operation
DataConnectorConnectContent content = new DataConnectorConnectContent()
{
    Kind = ConnectAuthKind.APIKey,
    ApiKey = "123456789",
    RequestConfigUserInputValues =
    {
    BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["displayText"] = "Organization Name",
    ["placeHolderName"] = "{{placeHolder1}}",
    ["placeHolderValue"] = "somePlaceHolderValue",
    ["requestObjectKey"] = "apiEndpoint"})
    },
};
await securityInsightsDataConnector.ConnectAsync(content);

Console.WriteLine($"Succeeded");

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

Пример ответа

Код состояния:: 200

Connect an APIPolling V2 logs data connector

Образец запроса

HTTP
dotnet

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"
    }
  ]
}

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/dataConnectors/ConnectAPIPollingV2Logs.json
// this example is just showing the usage of "DataConnectors_Connect" 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 SecurityInsightsDataConnectorResource created on azure
// for more information of creating SecurityInsightsDataConnectorResource, please refer to the document of SecurityInsightsDataConnectorResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
string dataConnectorId = "316ec55e-7138-4d63-ab18-90c8a60fd1c8";
ResourceIdentifier securityInsightsDataConnectorResourceId = SecurityInsightsDataConnectorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, dataConnectorId);
SecurityInsightsDataConnectorResource securityInsightsDataConnector = client.GetSecurityInsightsDataConnectorResource(securityInsightsDataConnectorResourceId);

// invoke the operation
DataConnectorConnectContent content = new DataConnectorConnectContent()
{
    Kind = ConnectAuthKind.APIKey,
    ApiKey = "123456789",
    DataCollectionEndpoint = "https://test.eastus.ingest.monitor.azure.com",
    DataCollectionRuleImmutableId = "dcr-34adsj9o7d6f9de204478b9cgb43b631",
    OutputStream = "Custom-MyTableRawData",
    RequestConfigUserInputValues =
    {
    BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    ["displayText"] = "Organization Name",
    ["placeHolderName"] = "{{placeHolder1}}",
    ["placeHolderValue"] = "somePlaceHolderValue",
    ["requestObjectKey"] = "apiEndpoint"})
    },
};
await securityInsightsDataConnector.ConnectAsync(content);

Console.WriteLine($"Succeeded");

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

Пример ответа

Код состояния:: 200

Определения

Имя	Описание
CloudError	Структура ответа на ошибки.
CloudErrorBody	Сведения об ошибке.
ConnectAuthKind	Тип проверки подлинности, используемый для опроса данных
DataConnectorConnectBody	Представляет соединитель данных опроса данных без кода.

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ConnectAuthKind

Перечисление

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

Значение	Описание
APIKey
Basic
OAuth2

DataConnectorConnectBody

Object

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

Имя	Тип	Описание
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	Имя пользователя на сервере журнала аудита.

Поделиться через

Data Connectors - Connect

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

Connect an APIPolling data connector

Образец запроса

Пример ответа

Connect an APIPolling V2 logs data connector

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

ConnectAuthKind

DataConnectorConnectBody

Дополнительные ресурсы