Freigeben über

Data Connectors - Connect

Dienst:
Sentinel
API-Version:
2025-07-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=2025-07-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataConnectorId
 path True

string

Konnektor-ID
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

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

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

Der Name des Arbeitsbereichs des Monitors.
api-version
 query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Typ Beschreibung
apiKey

string (password)

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 (password)

Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues

RequestConfigUserInputValues[]

userName

string

Der Benutzername im Überwachungsprotokollserver.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung ist erfolgreich.
Other Status Codes

CloudError

Unerwartete Fehlerantwort.

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

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-07-01-preview

{
  "apiKey": "123456789",
  "kind": "APIKey",
  "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

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-07-01-preview

{
  "apiKey": "123456789",
  "dataCollectionEndpoint": "https://test.eastus.ingest.monitor.azure.com",
  "dataCollectionRuleImmutableId": "dcr-34adsj9o7d6f9de204478b9cgb43b631",
  "kind": "APIKey",
  "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

Objekt

Fehlerantwortstruktur.

Name Typ Beschreibung
error

CloudErrorBody

Fehlerdaten

CloudErrorBody

Objekt

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

Enumeration

Die Authentifizierungsart, die zum Abrufen der Daten verwendet wird

Wert Beschreibung
Basic

Grundlegend
OAuth2

OAuth2
APIKey

APIKey

DataConnectorConnectBody

Objekt

Stellt Codeless API Polling Data Connector dar.

Name Typ Beschreibung
apiKey

string (password)

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 (password)

Das Benutzerkennwort auf dem Überwachungsprotokollserver.
requestConfigUserInputValues

RequestConfigUserInputValues[]

userName

string

Der Benutzername im Überwachungsprotokollserver.