코드리스 커넥터 프레임워크에 대한 데이터 커넥터 정의 참조

CCF(Codeless Connector Framework)를 사용하여 데이터 커넥터를 만들려면 이 문서를 데이터 커넥터 정의용 Microsoft Sentinel REST API 참조 문서에 대한 보완 문서로 사용합니다. 특히 이 참조 문서는 다음 섹션에서 확장됩니다.

• connectorUiConfig- Microsoft Sentinel 데이터 커넥터 페이지에 표시되는 시각적 요소 및 텍스트를 정의합니다.

자세한 내용은 코드리스 커넥터 만들기를 참조하세요.

데이터 커넥터 정의 - 만들기 또는 업데이트

REST API 문서에서 만들기 또는 업데이트 작업을 참조하여 안정적인 최신 또는 미리 보기 API 버전을 찾습니다. 작업에만 update 값이 etag 필요합니다.

PUT 메서드

https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.OperationalInsights/workspaces/{{workspaceName}}/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/{{dataConnectorDefinitionName}}?api-version={{apiVersion}}

URI 매개 변수

최신 API 버전에 대한 자세한 내용은 데이터 커넥터 정의 - URI 매개 변수 만들기 또는 업데이트를 참조하세요.

요청 본문

API를 사용하여 CCF 데이터 커넥터 정의를 만들기 위한 요청 본문에는 다음과 같은 구조가 있습니다.

{
    "kind": "Customizable",
    "properties": {
        "connectorUIConfig": {}
    }
}

dataConnectorDefinition 에는 다음과 같은 속성이 있습니다.

커넥터의 사용자 인터페이스 구성

이 섹션에서는 데이터 커넥터 페이지의 사용자 인터페이스를 사용자 지정하는 데 사용할 수 있는 구성 옵션에 대해 설명합니다.

다음 스크린샷은 사용자 인터페이스의 주목할 만한 영역에 해당하는 숫자로 강조 표시된 샘플 데이터 커넥터 페이지를 보여 줍니다.

사용자 인터페이스를 구성하는 데 필요한 섹션의 connectorUiConfig 다음 요소는 각각 API의 CustomizableConnectorUiConfig 부분에 해당합니다.

connectivityCriteria

dataTypes

graphQueries

지난 2주 동안의 데이터 수집을 표시하는 쿼리를 정의합니다.

모든 데이터 커넥터의 데이터 형식에 대해 하나의 쿼리 또는 각 데이터 형식에 대해 다른 쿼리를 제공합니다.

가용성

권한을

resourceProvider

sampleQueries

다른 링크 옵션 구성

markdown을 사용하여 인라인 링크를 정의하려면 다음 예제를 사용합니다.

{
   "title": "",
   "description": "Make sure to configure the machine's security according to your organization's security policy\n\n\n[Learn more >](https://aka.ms/SecureCEF)"
}

링크를 ARM 템플릿으로 정의하려면 다음 예제를 가이드로 사용합니다.

{
   "title": "Azure Resource Manager (ARM) template",
   "description": "1. Click the **Deploy to Azure** button below.\n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)]({URL to custom ARM template})"
}

instructionSteps

이 섹션에서는 Microsoft Sentinel 데이터 커넥터 페이지에 표시되고 다음과 같은 구조의 명령 집합을 정의하는 매개 변수를 제공합니다.

"instructionSteps": [
    {
        "title": "",
        "description": "",
        "instructions": [
        {
            "type": "",
            "parameters": {}
        }
        ],
        "innerSteps": {}
    }
]

지침

다양한 매개 변수와 더 많은 명령을 중첩할 수 있는 기능을 사용하여 명령 그룹을 그룹별로 표시합니다. 여기에 정의된 매개 변수는 해당합니다.

OAuthForm

이 구성 요소를 사용하려면 형식이 OAuth2데이터 커넥터 템플릿의 속성에 있어야auth 합니다.

"instructions": [
{
  "type": "OAuthForm",
  "parameters": {
    "clientIdLabel": "Client ID",
    "clientSecretLabel": "Client Secret",
    "connectButtonLabel": "Connect",
    "disconnectButtonLabel": "Disconnect"
  }          
}
]

텍스트 상자

다음은 형식의 몇 가지 예입니다 Textbox . 이러한 예제는 코드리스 커넥터 프레임워크에 대한 데이터 커넥터 참조의 예제 auth 섹션에 사용된 매개 변수에 해당합니다. 각각 4가지 형식에 대해 , labelplaceholder및 가 있습니다name.

"instructions": [
{
  "type": "Textbox",
  "parameters": {
      {
        "label": "User name",
        "placeholder": "User name",
        "type": "text",
        "name": "username"
      }
  }
},
{
  "type": "Textbox",
  "parameters": {
      "label": "Secret",
      "placeholder": "Secret",
      "type": "password",
      "name": "password"
  }
}
]

ConnectionToggleButton

"instructions": [
{
  "type": "ConnectionToggleButton",
  "parameters": {
    "connectLabel": "toggle",
    "name": "toggle"
  }          
}
]

CopyableLabel

예:

샘플 코드:

{
    "parameters": {
        "fillWith": [
            "WorkspaceId",
            "PrimaryKey"
            ],
        "label": "Here are some values you'll need to proceed.",
        "value": "Workspace is {0} and PrimaryKey is {1}"
    },
    "type": "CopyableLabel"
}

Dropdown

{
  "parameters": {
    "label": "Select an option",
    "name": "dropdown",
    "options": [
      {
        "key": "Option 1",
        "text": "option1"
      },
      {
        "key": "Option 2",
        "text": "option2"
      }
    ],
    "placeholder": "Select an option",
    "isMultiSelect": false,
    "required": true,
    "defaultAllSelected": false
  },
  "type": "Dropdown"
}

Markdown

{
  "parameters": {
    "content": "## This is a Markdown section\n\nYou can use **bold** text, _italic_ text, and even [links](https://www.example.com)."
  },
  "type": "Markdown"
}

DataConnectorsGrid

{
  "type": "DataConnectorsGrid",
  "parameters": {
    "mapping": [
      {
        "columnName": "Column 1",
        "columnValue": "Value 1"
      },
      {
        "columnName": "Column 2",
        "columnValue": "Value 2"
      }
    ],
    "menuItems": [
      "MyConnector"
    ]
  }
}

ContextPane

{
  "type": "ContextPane",
  "parameters": {
    "isPrimary": true,
    "label": "Add Account",
    "title": "Add Account",
    "subtitle": "Add Account",
    "contextPaneType": "DataConnectorsContextPane",
    "instructionSteps": [
      {
        "instructions": [
          {
            "type": "Textbox",
            "parameters": {
              "label": "Snowflake Account Identifier",
              "placeholder": "Enter Snowflake Account Identifier",
              "type": "text",
              "name": "accountId",
              "validations": {
                "required": true
              }
            }
          },
          {
            "type": "Textbox",
            "parameters": {
              "label": "Snowflake PAT",
              "placeholder": "Enter Snowflake PAT",
              "type": "password",
              "name": "apikey",
              "validations": {
                "required": true
              }
            }
          }
        ]
      }
    ]
  }
}

Infomessage

인라인 정보 메시지의 예는 다음과 같습니다.

반면, 다음 이미지는 인라인이 아닌 정보 메시지를 보여줍니다.

InstructionStepsGroup

확장 가능한 명령 그룹의 예는 다음과 같습니다.

자세한 예제는 Windows DNS 커넥터에 대한 구성 JSON을 참조하세요.

InstallAgent

일부 InstallAgent 형식은 단추로 표시되며 다른 형식은 링크로 표시됩니다. 다음은 두 가지의 예입니다.

예제 데이터 커넥터 정의

다음 예제에서는 데이터 만들기 또는 업데이트 커넥터 정의 API와 함께 사용할 JSON 본문 형식으로 이 문서에 정의된 일부 구성 요소를 함께 제공합니다.

다른 CCF 데이터 커넥터를 검토하는 connectorUiConfig 더 많은 예제를 보려면 레거시 CCF를 사용하는 커넥터에도 UI 만들기의 유효한 예가 있습니다.

{
    "kind": "Customizable",
    "properties": {
        "connectorUiConfig": {
          "title": "Example CCF Data Connector",
          "publisher": "My Company",
          "descriptionMarkdown": "This is an example of data connector",
          "graphQueriesTableName": "ExampleConnectorAlerts_CL",
          "graphQueries": [
            {
              "metricName": "Alerts received",
              "legend": "My data connector alerts",
              "baseQuery": "{{graphQueriesTableName}}"
            },   
           {
              "metricName": "Events received",
              "legend": "My data connector events",
              "baseQuery": "ASIMFileEventLogs"
            }
          ],
            "sampleQueries": [
            {
                "description": "All alert logs",
                "query": "{{graphQueriesTableName}} \n | take 10"
            }
          ],
          "dataTypes": [
            {
              "name": "{{graphQueriesTableName}}",
              "lastDataReceivedQuery": "{{graphQueriesTableName}} \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
            },
             {
              "name": "ASIMFileEventLogs",
              "lastDataReceivedQuery": "ASIMFileEventLogs \n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
             }
          ],
          "connectivityCriteria": [
            {
              "type": "HasDataConnectors"
            }
          ],
          "permissions": {
            "resourceProvider": [
              {
                "provider": "Microsoft.OperationalInsights/workspaces",
                "permissionsDisplayText": "Read and Write permissions are required.",
                "providerDisplayName": "Workspace",
                "scope": "Workspace",
                "requiredPermissions": {
                  "write": true,
                  "read": true,
                  "delete": true
                }
              },
            ],
            "customs": [
              {
                "name": "Example Connector API Key",
                "description": "The connector API key username and password is required"
              }
            ] 
        },
          "instructionSteps": [
            {
              "title": "Connect My Connector to Microsoft Sentinel",
              "description": "To enable the connector provide the required information below and click on Connect.\n>",
              "instructions": [
               {
                  "type": "Textbox",
                  "parameters": {
                    "label": "User name",
                    "placeholder": "User name",
                    "type": "text",
                    "name": "username"
                  }
                },
                {
                  "type": "Textbox",
                  "parameters": {
                    "label": "Secret",
                    "placeholder": "Secret",
                    "type": "password",
                    "name": "password"
                  }
                },
                {
                  "type": "ConnectionToggleButton",
                  "parameters": {
                    "connectLabel": "toggle",
                    "name": "toggle"
                  }
                }
              ]
            }
          ]
        }
    }
}