Tietoyhdistimen määritysviittaus Codeless Connector Frameworkille

Jos haluat luoda tietoyhdistimen Codeless Connector Frameworkin (CCF) avulla, käytä tätä asiakirjaa Microsoft Sentinel REST API for Data Connector Definitions -viitedokumentaatioiden täydennyksenä. Erityisesti tämä viiteasiakirja laajennetaan seuraavassa osassa:

• connectorUiConfig– määrittää visuaaliset elementit ja tekstin, jotka näytetään tietoyhdistinsivulla Microsoft Sentinel.

Lisätietoja on kohdassa Koodittoman liittimen luominen.

Tietoyhdistimen määritykset – Luominen tai päivittäminen

Katso uusin vakaa tai esikatselun ohjelmointirajapinnan versio rest-ohjelmointirajapintaohjeiden Luo tai päivitä -toiminnosta. update Vain toiminto edellyttää -etagarvoa.

PUT-menetelmä

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

URI-parametrit

Lisätietoja uusimmasta ohjelmointirajapintaversiosta on kohdassa Tietoyhdistimen määritykset – URI-parametrien luominen tai päivittäminen

Pyynnön leipäteksti

Pyynnön runko CCF-tietoliittimen määrityksen luomiseksi ohjelmointirajapinnan avulla sisältää seuraavan rakenteen:

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

dataConnectorDefinition sisältää seuraavat ominaisuudet:

Liittimen käyttöliittymän määrittäminen

Tässä osiossa kuvataan määritysasetukset, joiden avulla voit mukauttaa tietoyhdistinsivun käyttöliittymää.

Seuraavassa näyttökuvassa näkyy tietoyhdistimen mallisivu korostettuna numeroilla, jotka vastaavat käyttöliittymän merkittäviä alueita.

Kaikki seuraavat käyttöliittymän määrittämiseen tarvittavan connectorUiConfig osion elementit vastaavat ohjelmointirajapinnan CustomizableConnectorUiConfig-osaa.

connectivityCriteria

dataTypes

graphQueries

Määrittää kyselyn, joka esittää tietojen käsittelyt kahden viime viikon aikana.

Anna joko yksi kysely kaikille tietoliittimen tietotyypeille tai eri kysely kullekin tietotyypille.

Saatavuus

Käyttöoikeudet

resourceProvider

sampleQueries

Määritä muita linkkiasetuksia

Jos haluat määrittää sidotun linkin markdownin avulla, käytä seuraavaa esimerkkiä.

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

Jos haluat määrittää linkin ARM-malliksi, käytä seuraavaa esimerkkiä oppaana:

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

Tässä osiossa on parametreja, jotka määrittävät ohjejoukon, joka näkyy tietoyhdistinsivulla Microsoft Sentinel ja jolla on seuraava rakenne:

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

Ohjeet

Näyttää ohjeryhmän, jossa on useita parametreja ja mahdollisuus asettaa lisää ohjeitaVaiheet ryhmiin. Tässä määritetyt parametrit vastaavat toisiaan

OAuthForm

Tämä osa edellyttää, että OAuth2 tyyppi on tietoyhdistinmallin ominaisuudessaauth.

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

Oppikirja

Seuraavassa on joitakin esimerkkejä tyypistä Textbox . Nämä esimerkit vastaavat parametrit, joita käytetään tietoyhdistimien viittauksen esimerkkiosiossa authKoodittomassa liitinkehyksessä. Jokaisella 4 tyypillä on label, placeholderja 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

Esimerkki:

Mallikoodi:

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

Avattavasta

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

Kontekstiruutu

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

Tietoviesti

Tässä on esimerkki sisäisestä tietoviestistä:

Sen sijaan seuraavassa kuvassa näkyy tietoviesti, joka ei ole tekstiin sidottu:

InstructionStepsGroup

Tässä on esimerkki laajennettavasta ohjeryhmästä:

Yksityiskohtainen esimerkki on kohdassa JSON-määritys Windows DNS -liittimelle.

InstallAgent

Jotkin InstallAgent-tyypit näkyvät painikkeena, toiset linkkinä. Seuraavassa on esimerkkejä molemmista:

Esimerkki tietoyhdistimen määrityksestä

Seuraavassa esimerkissä kootaan yhteen joitakin osia, jotka on määritetty tässä artikkelissa JSON-leipätekstimuodoksi käytettäväksi luonti- tai päivitystietoyhdistimen määrityksen ohjelmointirajapinnan kanssa.

Katso lisää esimerkkejä connectorUiConfigmuista CCF-tietoyhdistimistä. Jopa vanhaa CCF:tä käyttävillä liittimillä on kelvollisia esimerkkejä käyttöliittymän luomisesta.

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