Data Connectors - Connect

Tjänst:

Sentinel

API-version:

2025-01-01-preview

Ansluter en dataanslutning.

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-parametrar

Name	I	Obligatorisk	Typ	Description
dataConnectorId	path	True	string	Anslutnings-ID
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceName	path	True	string	Namnet på arbetsytan. Reguljärt uttrycksmönster: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
apiKey	string	API-nyckeln för granskningsservern.
authorizationCode	string	Auktoriseringskoden som används i OAuth 2.0-kodflödet för att utfärda en token.
clientId	string	Klient-ID för OAuth 2.0-programmet.
clientSecret	string	Klienthemligheten för OAuth 2.0-programmet.
dataCollectionEndpoint	string	Används i v2-logganslutningsappen. Representerar datainsamlingens inmatningsslutpunkt i Log Analytics.
dataCollectionRuleImmutableId	string	Används i v2-logganslutningsappen. ID:t för datainsamlingsregeln är oföränderlig. Regeln definierar transformerings- och datamål.
kind	ConnectAuthKind	Den autentiseringstyp som används för att avsöka data
outputStream	string	Används i v2-logganslutningsappen. Strömmen vi skickar data till, det här är namnet på de streamDeclarations som definierats i DCR.
password	string	Användarlösenordet på granskningsloggservern.
requestConfigUserInputValues	object[]
userName	string	Användarnamnet på granskningsloggservern.

Svar

Name	Typ	Description
200 OK		OK, åtgärden har slutförts
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

Exempelbegäran

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

Exempelsvar

Statuskod:

200

Connect an APIPolling V2 logs data connector

Exempelbegäran

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

Exempelsvar

Statuskod:

200

Definitioner

Name	Description
CloudError	Felsvarsstruktur.
CloudErrorBody	Felinformation.
ConnectAuthKind	Den autentiseringstyp som används för att avsöka data
DataConnectorConnectBody	Representerar codeless API Polling data connector.

CloudError

Felsvarsstruktur.

Name	Typ	Description
error	CloudErrorBody	Feldata

CloudErrorBody

Felinformation.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

ConnectAuthKind

Den autentiseringstyp som används för att avsöka data

Name	Typ	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

Representerar codeless API Polling data connector.

Name	Typ	Description
apiKey	string	API-nyckeln för granskningsservern.
authorizationCode	string	Auktoriseringskoden som används i OAuth 2.0-kodflödet för att utfärda en token.
clientId	string	Klient-ID för OAuth 2.0-programmet.
clientSecret	string	Klienthemligheten för OAuth 2.0-programmet.
dataCollectionEndpoint	string	Används i v2-logganslutningsappen. Representerar datainsamlingens inmatningsslutpunkt i Log Analytics.
dataCollectionRuleImmutableId	string	Används i v2-logganslutningsappen. ID:t för datainsamlingsregeln är oföränderlig. Regeln definierar transformerings- och datamål.
kind	ConnectAuthKind	Den autentiseringstyp som används för att avsöka data
outputStream	string	Används i v2-logganslutningsappen. Strömmen vi skickar data till, det här är namnet på de streamDeclarations som definierats i DCR.
password	string	Användarlösenordet på granskningsloggservern.
requestConfigUserInputValues	object[]
userName	string	Användarnamnet på granskningsloggservern.