Data Connectors - Connect

서비스:

Sentinel

API 버전:

2024-01-01-preview

데이터 커넥터를 연결합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
dataConnectorId	path	True	string	커넥터 ID
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
workspaceName	path	True	string	작업 영역의 이름 regex 패턴: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
apiKey	string	감사 서버의 API 키입니다.
authorizationCode	string	OAuth 2.0 코드 흐름에서 토큰을 발급하는 데 사용되는 권한 부여 코드입니다.
clientId	string	OAuth 2.0 애플리케이션의 클라이언트 ID입니다.
clientSecret	string	OAuth 2.0 애플리케이션의 클라이언트 암호입니다.
dataCollectionEndpoint	string	v2 로그 커넥터에 사용됩니다. 로그 분석의 데이터 수집 엔드포인트를 나타냅니다.
dataCollectionRuleImmutableId	string	v2 로그 커넥터에 사용됩니다. 데이터 수집 규칙 변경할 수 없는 ID, 규칙은 변환 및 데이터 대상을 정의합니다.
kind	ConnectAuthKind	데이터를 폴링하는 데 사용되는 인증 종류
outputStream	string	v2 로그 커넥터에 사용됩니다. 데이터를 보내는 스트림으로, DCR에 정의된 streamDeclarations의 이름입니다.
password	string	감사 로그 서버의 사용자 암호입니다.
requestConfigUserInputValues	object[]
userName	string	감사 로그 서버의 사용자 이름입니다.

응답

Name	형식	Description
200 OK		확인, 작업이 성공적으로 완료되었습니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Connect an APIPolling data connector

Connect an APIPolling V2 logs data connector

Connect an APIPolling data connector

샘플 요청

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

샘플 응답

상태 코드:

200

Connect an APIPolling V2 logs data connector

샘플 요청

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

샘플 응답

상태 코드:

200

정의

Name	Description
CloudError	오류 응답 구조.
CloudErrorBody	오류 세부 정보입니다.
ConnectAuthKind	데이터를 폴링하는 데 사용되는 인증 종류
DataConnectorConnectBody	코드리스 API 폴링 데이터 커넥터를 나타냅니다.

CloudError

오류 응답 구조.

Name	형식	Description
error	CloudErrorBody	오류 데이터

CloudErrorBody

오류 세부 정보입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.

ConnectAuthKind

데이터를 폴링하는 데 사용되는 인증 종류

Name	형식	Description
APIKey	string
Basic	string
OAuth2	string

DataConnectorConnectBody

코드리스 API 폴링 데이터 커넥터를 나타냅니다.

Name	형식	Description
apiKey	string	감사 서버의 API 키입니다.
authorizationCode	string	OAuth 2.0 코드 흐름에서 토큰을 발급하는 데 사용되는 권한 부여 코드입니다.
clientId	string	OAuth 2.0 애플리케이션의 클라이언트 ID입니다.
clientSecret	string	OAuth 2.0 애플리케이션의 클라이언트 암호입니다.
dataCollectionEndpoint	string	v2 로그 커넥터에 사용됩니다. 로그 분석의 데이터 수집 엔드포인트를 나타냅니다.
dataCollectionRuleImmutableId	string	v2 로그 커넥터에 사용됩니다. 데이터 수집 규칙 변경할 수 없는 ID, 규칙은 변환 및 데이터 대상을 정의합니다.
kind	ConnectAuthKind	데이터를 폴링하는 데 사용되는 인증 종류
outputStream	string	v2 로그 커넥터에 사용됩니다. 데이터를 보내는 스트림으로, DCR에 정의된 streamDeclarations의 이름입니다.
password	string	감사 로그 서버의 사용자 암호입니다.
requestConfigUserInputValues	object[]
userName	string	감사 로그 서버의 사용자 이름입니다.