Data Connectors - Connect

Dienst:

Sentinel

API-Version:

2024-10-01-preview

Verbindet einen Datenconnector.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/connect?api-version=2024-10-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataConnectorId	path	True	string	Connector-ID
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName	path	True	string	Der Name des Arbeitsbereichs. RegEx-Muster: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
apiKey	string	Der API-Schlüssel des Überwachungsservers.
authorizationCode	string	Der autorisierungscode, der im OAuth 2.0-Codefluss zum Ausgeben eines Tokens verwendet wird.
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 Erfassungsendpunkt der Datensammlung in der Protokollanalyse dar.
dataCollectionRuleImmutableId	string	Wird im v2-Protokollconnector verwendet. Die Unveränderliche ID der Datensammlungsregel definiert die Transformation und das Datenziel.
kind	ConnectAuthKind	Die Authentifizierungsart, die zum Abrufen der Daten verwendet wird
outputStream	string	Wird im v2-Protokollconnector verwendet. Der Datenstrom, an den wir die Daten senden, ist dies der Name der streamDeclarations, die im DCR definiert sind.
password	string	Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues	object[]
userName	string	Der Benutzername im Überwachungsprotokollserver.

Antworten

Name	Typ	Beschreibung
200 OK		OK, Vorgang erfolgreich abgeschlossen
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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-10-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-10-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 Abrufen der Daten verwendet wird
DataConnectorConnectBody	Stellt Codeless API Polling Data Connector 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 sollen programmgesteuert genutzt werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

ConnectAuthKind

Die Authentifizierungsart, die zum Abrufen der Daten verwendet wird

Name	Typ	Beschreibung
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Stellt Codeless API Polling Data Connector dar.

Name	Typ	Beschreibung
apiKey	string	Der API-Schlüssel des Überwachungsservers.
authorizationCode	string	Der autorisierungscode, der im OAuth 2.0-Codefluss zum Ausgeben eines Tokens verwendet wird.
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 Erfassungsendpunkt der Datensammlung in der Protokollanalyse dar.
dataCollectionRuleImmutableId	string	Wird im v2-Protokollconnector verwendet. Die Unveränderliche ID der Datensammlungsregel definiert die Transformation und das Datenziel.
kind	ConnectAuthKind	Die Authentifizierungsart, die zum Abrufen der Daten verwendet wird
outputStream	string	Wird im v2-Protokollconnector verwendet. Der Datenstrom, an den wir die Daten senden, ist dies der Name der streamDeclarations, die im DCR definiert sind.
password	string	Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues	object[]
userName	string	Der Benutzername im Überwachungsprotokollserver.