Data Connectors - Connect

Servizio:

Sentinel

Versione API:

2025-01-01-preview

Connette un connettore dati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dataConnectorId	path	True	string	ID connettore
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceName	path	True	string	Nome dell'area di lavoro. Criterio di espressione regolare: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
apiKey	string	Chiave API del server di controllo.
authorizationCode	string	Codice di autorizzazione usato nel flusso di codice OAuth 2.0 per rilasciare un token.
clientId	string	ID client dell'applicazione OAuth 2.0.
clientSecret	string	Segreto client dell'applicazione OAuth 2.0.
dataCollectionEndpoint	string	Usato nel connettore di log v2. Rappresenta l'endpoint di inserimento della raccolta dati in Log Analytics.
dataCollectionRuleImmutableId	string	Usato nel connettore di log v2. L'ID non modificabile della regola di raccolta dati, la regola definisce la trasformazione e la destinazione dei dati.
kind	ConnectAuthKind	Tipo di autenticazione usato per eseguire il polling dei dati
outputStream	string	Usato nel connettore di log v2. Il flusso a cui vengono inviati i dati, ovvero il nome delle streamDeclarations definite nel DCR.
password	string	Password utente nel server di log di controllo.
requestConfigUserInputValues	object[]
userName	string	Nome utente nel server di log di controllo.

Risposte

Nome	Tipo	Descrizione
200 OK		OK, operazione completata
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

Connect an APIPolling V2 logs data connector

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

Definizioni

Nome	Descrizione
CloudError	Struttura della risposta di errore.
CloudErrorBody	Dettagli errore.
ConnectAuthKind	Tipo di autenticazione usato per eseguire il polling dei dati
DataConnectorConnectBody	Rappresenta il connettore dati di polling dell'API senza codice.

CloudError

Struttura della risposta di errore.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dati degli errori

CloudErrorBody

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

ConnectAuthKind

Tipo di autenticazione usato per eseguire il polling dei dati

Nome	Tipo	Descrizione
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Rappresenta il connettore dati di polling dell'API senza codice.

Nome	Tipo	Descrizione
apiKey	string	Chiave API del server di controllo.
authorizationCode	string	Codice di autorizzazione usato nel flusso di codice OAuth 2.0 per rilasciare un token.
clientId	string	ID client dell'applicazione OAuth 2.0.
clientSecret	string	Segreto client dell'applicazione OAuth 2.0.
dataCollectionEndpoint	string	Usato nel connettore di log v2. Rappresenta l'endpoint di inserimento della raccolta dati in Log Analytics.
dataCollectionRuleImmutableId	string	Usato nel connettore di log v2. L'ID non modificabile della regola di raccolta dati, la regola definisce la trasformazione e la destinazione dei dati.
kind	ConnectAuthKind	Tipo di autenticazione usato per eseguire il polling dei dati
outputStream	string	Usato nel connettore di log v2. Il flusso a cui vengono inviati i dati, ovvero il nome delle streamDeclarations definite nel DCR.
password	string	Password utente nel server di log di controllo.
requestConfigUserInputValues	object[]
userName	string	Nome utente nel server di log di controllo.