Data Connectors - Connect

Service:

Sentinel

API Version:

2024-01-01-preview

Connecte un connecteur de données.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dataConnectorId	path	True	string	ID Connecteur
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
apiKey	string	Clé API du serveur d’audit.
authorizationCode	string	Code d’autorisation utilisé dans le flux de code OAuth 2.0 pour émettre un jeton.
clientId	string	ID client de l’application OAuth 2.0.
clientSecret	string	Clé secrète client de l’application OAuth 2.0.
dataCollectionEndpoint	string	Utilisé dans le connecteur de journaux v2. Représente le point de terminaison d’ingestion de collecte de données dans Log Analytics.
dataCollectionRuleImmutableId	string	Utilisé dans le connecteur de journaux v2. Id immuable de la règle de collecte de données, la règle définit la transformation et la destination des données.
kind	ConnectAuthKind	Type d’authentification utilisé pour interroger les données
outputStream	string	Utilisé dans le connecteur de journaux v2. Flux auquel nous envoyons les données, il s’agit du nom des déclarations streamDeclarations définies dans la DCR.
password	string	Mot de passe utilisateur dans le serveur de journaux d’audit.
requestConfigUserInputValues	object[]
userName	string	Nom d’utilisateur dans le serveur de journaux d’audit.

Réponses

Nom	Type	Description
200 OK		OK, Opération terminée
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Sample Request

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

Sample Response

Status code:

200

Connect an APIPolling V2 logs data connector

Sample Request

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

Sample Response

Status code:

200

Définitions

Nom	Description
CloudError	Structure de réponse d’erreur.
CloudErrorBody	Détails de l’erreur.
ConnectAuthKind	Type d’authentification utilisé pour interroger les données
DataConnectorConnectBody	Représente le connecteur de données d’interrogation d’API sans code.

CloudError

Structure de réponse d’erreur.

Nom	Type	Description
error	CloudErrorBody	Données d’erreur

CloudErrorBody

Détails de l’erreur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

ConnectAuthKind

Type d’authentification utilisé pour interroger les données

Nom	Type	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Représente le connecteur de données d’interrogation d’API sans code.

Nom	Type	Description
apiKey	string	Clé API du serveur d’audit.
authorizationCode	string	Code d’autorisation utilisé dans le flux de code OAuth 2.0 pour émettre un jeton.
clientId	string	ID client de l’application OAuth 2.0.
clientSecret	string	Clé secrète client de l’application OAuth 2.0.
dataCollectionEndpoint	string	Utilisé dans le connecteur de journaux v2. Représente le point de terminaison d’ingestion de collecte de données dans Log Analytics.
dataCollectionRuleImmutableId	string	Utilisé dans le connecteur de journaux v2. Id immuable de la règle de collecte de données, la règle définit la transformation et la destination des données.
kind	ConnectAuthKind	Type d’authentification utilisé pour interroger les données
outputStream	string	Utilisé dans le connecteur de journaux v2. Flux auquel nous envoyons les données, il s’agit du nom des déclarations streamDeclarations définies dans la DCR.
password	string	Mot de passe utilisateur dans le serveur de journaux d’audit.
requestConfigUserInputValues	object[]
userName	string	Nom d’utilisateur dans le serveur de journaux d’audit.