Udostępnij przez

Data Connectors - Connect

Usługa:
Sentinel
Wersja interfejsu API:
2025-07-01-preview

Łączy łącznik danych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dataConnectorId
 path True

string

Identyfikator łącznika
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceName
 path True

string

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

Nazwa obszaru roboczego.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Typ Opis
apiKey

string

Klucz interfejsu API serwera inspekcji.
authorizationCode

string

Kod autoryzacji używany w przepływie kodu OAuth 2.0 do wystawiania tokenu.
clientId

string

Identyfikator klienta aplikacji OAuth 2.0.
clientSecret

string

Wpis tajny klienta aplikacji OAuth 2.0.
dataCollectionEndpoint

string

Używany w łączniku dzienników w wersji 2. Reprezentuje punkt końcowy pozyskiwania danych w usłudze Log Analytics.
dataCollectionRuleImmutableId

string

Używany w łączniku dzienników w wersji 2. Niezmienny identyfikator reguły zbierania danych, reguła definiuje przekształcenie i miejsce docelowe danych.
kind

ConnectAuthKind

Rodzaj uwierzytelniania używany do sondowania danych
outputStream

string

Używany w łączniku dzienników w wersji 2. Strumień, do który wysyłamy dane, jest to nazwa strumieniaDeclarations zdefiniowanych w kontrolerze domeny.
password

string

Hasło użytkownika na serwerze dziennika inspekcji.
requestConfigUserInputValues

object[]

userName

string

Nazwa użytkownika na serwerze dziennika inspekcji.

Odpowiedzi

Nazwa Typ Opis
200 OK

OK, operacja została ukończona pomyślnie
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Connect an APIPolling data connector
Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Przykładowe żądanie

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

{
  "kind": "APIKey",
  "apiKey": "123456789",
  "requestConfigUserInputValues": [
    {
      "displayText": "Organization Name",
      "placeHolderName": "{{placeHolder1}}",
      "placeHolderValue": "somePlaceHolderValue",
      "requestObjectKey": "apiEndpoint"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200

Connect an APIPolling V2 logs data connector

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
200

Definicje

Nazwa Opis
CloudError

Struktura odpowiedzi na błędy.
CloudErrorBody

Szczegóły błędu.
ConnectAuthKind

Rodzaj uwierzytelniania używany do sondowania danych
DataConnectorConnectBody

Reprezentuje łącznik danych sondowania interfejsu API bez kodu.

CloudError

Objekt

Struktura odpowiedzi na błędy.

Nazwa Typ Opis
error

CloudErrorBody

Dane o błędzie

CloudErrorBody

Objekt

Szczegóły błędu.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

ConnectAuthKind

Wyliczanie

Rodzaj uwierzytelniania używany do sondowania danych

Wartość Opis
Basic
OAuth2
APIKey

DataConnectorConnectBody

Objekt

Reprezentuje łącznik danych sondowania interfejsu API bez kodu.

Nazwa Typ Opis
apiKey

string

Klucz interfejsu API serwera inspekcji.
authorizationCode

string

Kod autoryzacji używany w przepływie kodu OAuth 2.0 do wystawiania tokenu.
clientId

string

Identyfikator klienta aplikacji OAuth 2.0.
clientSecret

string

Wpis tajny klienta aplikacji OAuth 2.0.
dataCollectionEndpoint

string

Używany w łączniku dzienników w wersji 2. Reprezentuje punkt końcowy pozyskiwania danych w usłudze Log Analytics.
dataCollectionRuleImmutableId

string

Używany w łączniku dzienników w wersji 2. Niezmienny identyfikator reguły zbierania danych, reguła definiuje przekształcenie i miejsce docelowe danych.
kind

ConnectAuthKind

Rodzaj uwierzytelniania używany do sondowania danych
outputStream

string

Używany w łączniku dzienników w wersji 2. Strumień, do który wysyłamy dane, jest to nazwa strumieniaDeclarations zdefiniowanych w kontrolerze domeny.
password

string

Hasło użytkownika na serwerze dziennika inspekcji.
requestConfigUserInputValues

object[]

userName

string

Nazwa użytkownika na serwerze dziennika inspekcji.