Data Connectors - Connect

Služba:

Sentinel

Verze rozhraní API:

2025-01-01-preview

Připojí datový konektor.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataConnectorId	path	True	string	ID konektoru
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
workspaceName	path	True	string	Název pracovního prostoru. Vzor regulárního výrazu: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
apiKey	string	Klíč rozhraní API serveru auditu.
authorizationCode	string	Autorizační kód použitý v toku kódu OAuth 2.0 k vydání tokenu.
clientId	string	ID klienta aplikace OAuth 2.0.
clientSecret	string	Tajný klíč klienta aplikace OAuth 2.0.
dataCollectionEndpoint	string	Používá se v konektoru protokolů v2. Představuje koncový bod pro příjem dat v Log Analytics.
dataCollectionRuleImmutableId	string	Používá se v konektoru protokolů v2. Neměnné ID pravidla shromažďování dat definuje pravidlo transformace a cíle dat.
kind	ConnectAuthKind	Druh ověřování použitý k dotazování dat
outputStream	string	Používá se v konektoru protokolů v2. Stream, do něhož odesíláme data, je to název streamDeclarations definovaných v DCR.
password	string	Heslo uživatele na serveru protokolu auditu.
requestConfigUserInputValues	object[]
userName	string	Uživatelské jméno na serveru protokolu auditu.

Odpovědi

Name	Typ	Description
200 OK		OK, operace byla úspěšně dokončena.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

Connect an APIPolling V2 logs data connector

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

Definice

Name	Description
CloudError	Struktura odpovědi na chybu
CloudErrorBody	Podrobnosti o chybě
ConnectAuthKind	Druh ověřování použitý k dotazování dat
DataConnectorConnectBody	Představuje datový konektor dotazování rozhraní API bez kódu.

CloudError

Struktura odpovědi na chybu

Name	Typ	Description
error	CloudErrorBody	Data o chybách

CloudErrorBody

Podrobnosti o chybě

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

ConnectAuthKind

Druh ověřování použitý k dotazování dat

Name	Typ	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Představuje datový konektor dotazování rozhraní API bez kódu.

Name	Typ	Description
apiKey	string	Klíč rozhraní API serveru auditu.
authorizationCode	string	Autorizační kód použitý v toku kódu OAuth 2.0 k vydání tokenu.
clientId	string	ID klienta aplikace OAuth 2.0.
clientSecret	string	Tajný klíč klienta aplikace OAuth 2.0.
dataCollectionEndpoint	string	Používá se v konektoru protokolů v2. Představuje koncový bod pro příjem dat v Log Analytics.
dataCollectionRuleImmutableId	string	Používá se v konektoru protokolů v2. Neměnné ID pravidla shromažďování dat definuje pravidlo transformace a cíle dat.
kind	ConnectAuthKind	Druh ověřování použitý k dotazování dat
outputStream	string	Používá se v konektoru protokolů v2. Stream, do něhož odesíláme data, je to název streamDeclarations definovaných v DCR.
password	string	Heslo uživatele na serveru protokolu auditu.
requestConfigUserInputValues	object[]
userName	string	Uživatelské jméno na serveru protokolu auditu.