Referanse for definisjoner av datakoblinger for Codeless Connector Framework

Hvis du vil opprette en datakobling med Codeless Connector Framework (CCF), kan du bruke dette dokumentet som et tillegg til referansedokumentene for Microsoft Sentinel REST-API for datakoblingsdefinisjoner. Dette referansedokumentet utvides spesifikt i følgende avsnitt:

• connectorUiConfig– definerer de visuelle elementene og teksten som vises på datakoblingssiden i Microsoft Sentinel.

Hvis du vil ha mer informasjon, kan du se Opprette en kodeløs kobling.

Datakoblingsdefinisjoner – Opprett eller oppdater

Referer til Opprett eller oppdater-operasjonen i REST-API-dokumentene for å finne den nyeste stabile eller forhåndsvise API-versjonen. update Bare operasjonen krever etag verdien.

PUT-metode

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

URI-parametere

Hvis du vil ha mer informasjon om den nyeste API-versjonen, kan du se Data Connector Definitions – Opprette eller oppdatere URI-parametere

Forespørselstekst

Forespørselsteksten for å opprette en definisjon av CCF-datakobling med API-en har følgende struktur:

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

dataConnectorDefinition har følgende egenskaper:

Konfigurere brukergrensesnittet for koblingen

Denne delen beskriver konfigurasjonsalternativene som er tilgjengelige for å tilpasse brukergrensesnittet på datakoblingssiden.

Det følgende skjermbildet viser en eksempelside for datakobling, uthevet med tall som tilsvarer viktige områder i brukergrensesnittet.

Hver av de følgende elementene i inndelingen connectorUiConfig som kreves for å konfigurere brukergrensesnittet, samsvarer med customizableConnectorUiConfig-delen av API-en.

connectivityCriteria

Datatyper

graphQueries

Definerer en spørring som presenterer datainntak i løpet av de siste to ukene.

Angi én spørring for alle datatypene for datakoblingen, eller en annen spørring for hver datatype.

Tilgjengelighet

Tillatelser

resourceProvider

sampleQueries

Konfigurere andre koblingsalternativer

Hvis du vil definere en innebygd kobling ved hjelp av markdown, bruker du følgende eksempel.

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

Hvis du vil definere en kobling som en ARM-mal, bruker du følgende eksempel som en veiledning:

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

instruksjonstrinn

Denne delen inneholder parametere som definerer settet med instruksjoner som vises på datakoblingssiden i Microsoft Sentinel og har følgende struktur:

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

Instruksjoner

Viser en gruppe med instruksjoner, med ulike parametere og muligheten til å neste flere instruksjonstrinn i grupper. Parametere som er definert her korresponderer

OAuthForm

Denne komponenten OAuth2 krever at typen finnes i auth egenskapen til datakoblingsmalen.

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

Tekstboksen

Her er noen eksempler på Textbox typen. Disse eksemplene tilsvarer parameterne som brukes i eksempeldelen auth i datakoblingsreferansen for Codeless Connector Framework. Hver av de fire typene har label, placeholderog 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

Eksempel:

Eksempelkode:

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

Her er et eksempel på en innebygd informasjonsmelding:

Bildet nedenfor viser derimot en informasjonsmelding som ikke er innebygd:

InstructionStepsGroup

Her er et eksempel på en utvidbar instruksjonsgruppe:

Hvis du vil ha et detaljert eksempel, kan du se konfigurasjonen JSON for Windows DNS-koblingen.

InstallAgent

Noen InstallAgent-typer vises som en knapp, andre vises som en kobling. Her er eksempler på begge:

Eksempel på datakoblingsdefinisjon

Det følgende eksemplet samler noen av komponentene som er definert i denne artikkelen, som et JSON-brødtekstformat som skal brukes med definisjons-API-en for Opprett eller oppdater datakobling.

Hvis du vil ha flere eksempler på connectorUiConfig gjennomgang av andre CCF-datakoblinger. Selv koblinger som bruker den eldre CCF-filen, har gyldige eksempler på oppretting av brukergrensesnittet.

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