Data Connectors - Connect

Service:

Sentinel

API-versie:

2025-01-01-preview

Hiermee wordt een gegevensconnector verbonden.

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

URI-parameters

Name	In	Vereist	Type	Description
dataConnectorId	path	True	string	Connector-id
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string uuid	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceName	path	True	string	De naam van de werkruimte. Regex-patroon: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
apiKey	string	De API-sleutel van de controleserver.
authorizationCode	string	De autorisatiecode die wordt gebruikt in de OAuth 2.0-codestroom om een token uit te geven.
clientId	string	De client-id van de OAuth 2.0-toepassing.
clientSecret	string	Het clientgeheim van de OAuth 2.0-toepassing.
dataCollectionEndpoint	string	Wordt gebruikt in v2-logboekenconnector. Vertegenwoordigt het opname-eindpunt voor gegevensverzameling in Log Analytics.
dataCollectionRuleImmutableId	string	Wordt gebruikt in v2-logboekenconnector. De onveranderbare id van de regel voor gegevensverzameling definieert de transformatie en het doel van de gegevens.
kind	ConnectAuthKind	Het verificatietype dat wordt gebruikt om de gegevens te peilen
outputStream	string	Wordt gebruikt in v2-logboekenconnector. De stream waarmee we de gegevens verzenden, is dit de naam van de streamDeclarations die zijn gedefinieerd in de DCR.
password	string	Het gebruikerswachtwoord op de auditlogboekserver.
requestConfigUserInputValues	object[]
userName	string	De gebruikersnaam in de auditlogboekserver.

Antwoorden

Name	Type	Description
200 OK		Ok, de bewerking is voltooid
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

Connect an APIPolling V2 logs data connector

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

Definities

Name	Description
CloudError	Structuur van foutreacties.
CloudErrorBody	Foutdetails.
ConnectAuthKind	Het verificatietype dat wordt gebruikt om de gegevens te peilen
DataConnectorConnectBody	Vertegenwoordigt codeloze API Polling-gegevensconnector.

CloudError

Structuur van foutreacties.

Name	Type	Description
error	CloudErrorBody	Foutgegevens

CloudErrorBody

Foutdetails.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

ConnectAuthKind

Het verificatietype dat wordt gebruikt om de gegevens te peilen

Name	Type	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Vertegenwoordigt codeloze API Polling-gegevensconnector.

Name	Type	Description
apiKey	string	De API-sleutel van de controleserver.
authorizationCode	string	De autorisatiecode die wordt gebruikt in de OAuth 2.0-codestroom om een token uit te geven.
clientId	string	De client-id van de OAuth 2.0-toepassing.
clientSecret	string	Het clientgeheim van de OAuth 2.0-toepassing.
dataCollectionEndpoint	string	Wordt gebruikt in v2-logboekenconnector. Vertegenwoordigt het opname-eindpunt voor gegevensverzameling in Log Analytics.
dataCollectionRuleImmutableId	string	Wordt gebruikt in v2-logboekenconnector. De onveranderbare id van de regel voor gegevensverzameling definieert de transformatie en het doel van de gegevens.
kind	ConnectAuthKind	Het verificatietype dat wordt gebruikt om de gegevens te peilen
outputStream	string	Wordt gebruikt in v2-logboekenconnector. De stream waarmee we de gegevens verzenden, is dit de naam van de streamDeclarations die zijn gedefinieerd in de DCR.
password	string	Het gebruikerswachtwoord op de auditlogboekserver.
requestConfigUserInputValues	object[]
userName	string	De gebruikersnaam in de auditlogboekserver.