Data Connectors - Connect

Referencia

Szolgáltatás:: Sentinel

API-verzió:: 2024-01-01-preview

Adatösszekötőt csatlakoztat.

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-paraméterek

Name	In	Kötelező	Típus	Description
dataConnectorId	path	True	string	Összekötő azonosítója
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	A munkaterület neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Típus	Description
apiKey	string	A naplózási kiszolgáló API-kulcsa.
authorizationCode	string	Az OAuth 2.0 kódfolyamatban a jogkivonat kiállításához használt engedélyezési kód.
clientId	string	Az OAuth 2.0 alkalmazás ügyfélazonosítója.
clientSecret	string	Az OAuth 2.0-alkalmazás ügyfélkódja.
dataCollectionEndpoint	string	V2-naplók összekötőjében használatos. Az adatgyűjtési betöltési végpontot jelöli a log analyticsben.
dataCollectionRuleImmutableId	string	V2-naplók összekötőjében használatos. Az adatgyűjtési szabály nem módosítható azonosítója, a szabály határozza meg az átalakítást és az adatcélt.
kind	ConnectAuthKind	Az adatok lekérdezéséhez használt hitelesítési típus
outputStream	string	V2-naplók összekötőjében használatos. A stream, amelybe az adatokat küldjük, ez a DCR-ben definiált streamDeclarations neve.
password	string	A felhasználói jelszó a naplókiszolgálón.
requestConfigUserInputValues	object[]
userName	string	Az auditnapló-kiszolgáló felhasználóneve.

Válaszok

Name	Típus	Description
200 OK		OK, a művelet sikeresen befejeződött
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkód:: 200

Connect an APIPolling V2 logs data connector

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

Definíciók

Name	Description
CloudError	Hibaválasz-struktúra.
CloudErrorBody	Hiba részletei.
ConnectAuthKind	Az adatok lekérdezéséhez használt hitelesítési típus
DataConnectorConnectBody	Kód nélküli API-lekérdezési adatösszekötőt jelöl.

CloudError

Objektum

Hibaválasz-struktúra.

Name	Típus	Description
error	CloudErrorBody	Hibaadatok

CloudErrorBody

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

ConnectAuthKind

Enumerálás

Az adatok lekérdezéséhez használt hitelesítési típus

Érték	Description
APIKey
Basic
OAuth2

DataConnectorConnectBody

Objektum

Kód nélküli API-lekérdezési adatösszekötőt jelöl.

Name	Típus	Description
apiKey	string	A naplózási kiszolgáló API-kulcsa.
authorizationCode	string	Az OAuth 2.0 kódfolyamatban a jogkivonat kiállításához használt engedélyezési kód.
clientId	string	Az OAuth 2.0 alkalmazás ügyfélazonosítója.
clientSecret	string	Az OAuth 2.0-alkalmazás ügyfélkódja.
dataCollectionEndpoint	string	V2-naplók összekötőjében használatos. Az adatgyűjtési betöltési végpontot jelöli a log analyticsben.
dataCollectionRuleImmutableId	string	V2-naplók összekötőjében használatos. Az adatgyűjtési szabály nem módosítható azonosítója, a szabály határozza meg az átalakítást és az adatcélt.
kind	ConnectAuthKind	Az adatok lekérdezéséhez használt hitelesítési típus
outputStream	string	V2-naplók összekötőjében használatos. A stream, amelybe az adatokat küldjük, ez a DCR-ben definiált streamDeclarations neve.
password	string	A felhasználói jelszó a naplókiszolgálón.
requestConfigUserInputValues	object[]
userName	string	Az auditnapló-kiszolgáló felhasználóneve.

Megosztás a következőn keresztül:

Data Connectors - Connect

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Connect an APIPolling data connector

Mintakérelem

Mintaválasz

Connect an APIPolling V2 logs data connector

Mintakérelem

Mintaválasz

Definíciók

CloudError

CloudErrorBody

ConnectAuthKind

DataConnectorConnectBody

További források