Data Connectors - Connect

Dienst:

Sentinel

API-Version:

2024-01-01-preview

Stellt eine Verbindung mit einem Datenconnector her.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataConnectorId	path	True	string	Connector-ID
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	path	True	string	Den Namen des Arbeitsbereichs RegEx-Muster: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
apiKey	string	Der API-Schlüssel des Überwachungsservers.
authorizationCode	string	Der Autorisierungscode, der im OAuth 2.0-Codeflow verwendet wird, um ein Token auszustellen.
clientId	string	Die Client-ID der OAuth 2.0-Anwendung.
clientSecret	string	Der geheime Clientschlüssel der OAuth 2.0-Anwendung.
dataCollectionEndpoint	string	Wird im v2-Protokollconnector verwendet. Stellt den Datenerfassungsendpunkt in Log Analytics dar.
dataCollectionRuleImmutableId	string	Wird im v2-Protokollconnector verwendet. Die unveränderliche ID der Datensammlungsregel, die Regel definiert die Transformation und das Datenziel.
kind	ConnectAuthKind	Die Authentifizierungsart, die zum Abfragen der Daten verwendet wird
outputStream	string	Wird im v2-Protokollconnector verwendet. Der Stream, an den wir die Daten senden. Dies ist der Name der in der DCR definierten streamDeclarations.
password	string	Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues	object[]
userName	string	Der Benutzername auf dem Überwachungsprotokollserver.

Antworten

Name	Typ	Beschreibung
200 OK		OK, Vorgang erfolgreich abgeschlossen
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

Connect an APIPolling V2 logs data connector

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
CloudError	Fehlerantwortstruktur.
CloudErrorBody	Fehlerdetails.
ConnectAuthKind	Die Authentifizierungsart, die zum Abfragen der Daten verwendet wird
DataConnectorConnectBody	Stellt den Codelosen API-Abfragedatenconnector dar.

CloudError

Fehlerantwortstruktur.

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerdaten

CloudErrorBody

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

ConnectAuthKind

Die Authentifizierungsart, die zum Abfragen der Daten verwendet wird

Name	Typ	Beschreibung
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Stellt den Codelosen API-Abfragedatenconnector dar.

Name	Typ	Beschreibung
apiKey	string	Der API-Schlüssel des Überwachungsservers.
authorizationCode	string	Der Autorisierungscode, der im OAuth 2.0-Codeflow verwendet wird, um ein Token auszustellen.
clientId	string	Die Client-ID der OAuth 2.0-Anwendung.
clientSecret	string	Der geheime Clientschlüssel der OAuth 2.0-Anwendung.
dataCollectionEndpoint	string	Wird im v2-Protokollconnector verwendet. Stellt den Datenerfassungsendpunkt in Log Analytics dar.
dataCollectionRuleImmutableId	string	Wird im v2-Protokollconnector verwendet. Die unveränderliche ID der Datensammlungsregel, die Regel definiert die Transformation und das Datenziel.
kind	ConnectAuthKind	Die Authentifizierungsart, die zum Abfragen der Daten verwendet wird
outputStream	string	Wird im v2-Protokollconnector verwendet. Der Stream, an den wir die Daten senden. Dies ist der Name der in der DCR definierten streamDeclarations.
password	string	Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues	object[]
userName	string	Der Benutzername auf dem Überwachungsprotokollserver.