Referens för definitioner för dataanslutningsprogram för Codeless Connector Framework

Om du vill skapa en dataanslutning med Codeless Connector Framework (CCF) använder du det här dokumentet som ett komplement till referensdokumenten för Microsoft Sentinel REST API for Data Connector Definitions. Mer specifikt expanderar det här referensdokumentet i följande avsnitt:

• connectorUiConfig– definierar de visuella element och text som visas på sidan för dataanslutningsappen i Microsoft Sentinel.

Mer information finns i Skapa en kodlös anslutningsapp.

Definitioner för dataanslutningsprogram – Skapa eller uppdatera

Referera till åtgärden Skapa eller uppdatera i REST API-dokumenten för att hitta den senaste stabila api-versionen eller förhandsversionen av API:et. Endast åtgärden update kräver värdet etag .

PUT-metod

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

URI-parametrar

Mer information om den senaste API-versionen finns i Definitioner för dataanslutningsprogram – Skapa eller uppdatera URI-parametrar

Frågebrödtext

Begärandetexten för att skapa en definition av CCF-dataanslutningsappen med API:et har följande struktur:

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

dataConnectorDefinition har följande egenskaper:

Konfigurera anslutningsappens användargränssnitt

I det här avsnittet beskrivs de konfigurationsalternativ som är tillgängliga för att anpassa användargränssnittet på sidan för dataanslutningsappen.

Följande skärmbild visar en exempelsida för dataanslutningsappen, markerad med siffror som motsvarar viktiga områden i användargränssnittet.

Vart och ett av följande element i connectorUiConfig avsnittet som behövs för att konfigurera användargränssnittet motsvarar delen CustomizableConnectorUiConfig i API:et.

connectivityCriteria

Datatyper

graphQueries

Definierar en fråga som visar datainmatning under de senaste två veckorna.

Ange antingen en fråga för alla dataanslutningsappens datatyper eller en annan fråga för varje datatyp.

Tillgänglighet

Behörigheter

resourceProvider

sampleQueries

Konfigurera andra länkalternativ

Om du vill definiera en infogad länk med markdown använder du följande exempel.

{
   "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)"
}

Om du vill definiera en länk som en ARM-mall använder du följande exempel som en guide:

{
   "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

Det här avsnittet innehåller parametrar som definierar den uppsättning instruktioner som visas på sidan för dataanslutningsappen i Microsoft Sentinel och som har följande struktur:

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

Instruktioner

Visar en grupp med instruktioner med olika parametrar och möjlighet att kapsla fler instruktionerSteg i grupper. Parametrar som definieras här motsvarar

OAuthForm

Den här komponenten OAuth2 kräver att typen finns i auth egenskapen för dataanslutningsmallen.

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

Textrutan

Här är några exempel på Textbox typen. De här exemplen motsvarar de parametrar som används i exempelavsnittet auth i referensen för dataanslutningsappar för Codeless Connector Framework. För var och en av de 4 typerna har labelvar och en , placeholderoch 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

Exempel:

Exempelkod:

{
    "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

Här är ett exempel på ett infogat informationsmeddelande:

Följande bild visar däremot ett informationsmeddelande som inte är infogat:

InstructionStepsGroup

Här är ett exempel på en expanderbar instruktionsgrupp:

Ett detaljerat exempel finns i JSON-konfigurationen för Windows DNS-anslutningsappen.

InstallAgent

Vissa InstallAgent-typer visas som en knapp, andra visas som en länk. Här är exempel på båda:

Exempel på definition av dataanslutningsprogram

I följande exempel sammanförs några av de komponenter som definierats i den här artikeln som ett JSON-brödtextformat som ska användas med definitions-API:et för att skapa eller uppdatera dataanslutningsappen.

Fler exempel på granskning connectorUiConfig av andra CCF-dataanslutningar. Även anslutningsappar som använder den äldre CCF:en har giltiga exempel på hur användargränssnittet skapas.

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