Naslaginformatie over definities van gegevensconnector voor het Codeless Connector Framework

Als u een gegevensconnector wilt maken met het Codeless Connector Framework (CCF), gebruikt u dit document als aanvulling op de Microsoft Sentinel REST API voor Data Connector Definitions-referentiedocumenten . Dit referentiedocument wordt specifiek uitgebreid in de volgende sectie:

connectorUiConfig - definieert de visuele elementen en tekst die wordt weergegeven op de pagina gegevensconnector in Microsoft Sentinel.

Zie Een connector zonder code maken voor meer informatie.

Definities van gegevensconnector - Maken of bijwerken

Raadpleeg de bewerking Maken of bijwerken in de REST API-documenten om de nieuwste stabiele of preview-API-versie te vinden. Alleen voor de update bewerking is de etag waarde vereist.

PUT-methode

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

URI Parameters

Zie Data Connector Definitions - Create or Update URI Parameters (URI-parameters maken of bijwerken) voor meer informatie over de nieuwste API-versie

Naam	Beschrijving
dataConnectorDefinitionName	De definitie van de gegevensconnector moet een unieke naam zijn en is hetzelfde als de `name` parameter in de aanvraagbody.
resourceGroupName	De naam van de resourcegroep, niet hoofdlettergevoelig.
subscriptionId	De id van het doelabonnement.
workspaceName	De naam van de werkruimte, niet de id. Regex-patroon: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	De API-versie die voor deze bewerking moet worden gebruikt.

Inhoud van het verzoek

De aanvraagbody voor het maken van een definitie van een CCF-gegevensconnector met de API heeft de volgende structuur:

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

dataConnectorDefinition heeft de volgende eigenschappen:

Naam	Verplicht	Typologie	Beschrijving
Soort	Klopt	Snaar / Touwtje	`Customizable` voor api-polling-gegevensconnector of `Static` anderszins
Eigenschappen. connectorUiConfig	Klopt	Geneste JSON connectorUiConfig	De eigenschappen van de gebruikersinterfaceconfiguratie van de gegevensconnector

De gebruikersinterface van uw connector configureren

In deze sectie worden de configuratieopties beschreven die beschikbaar zijn om de gebruikersinterface van de pagina gegevensconnector aan te passen.

In de volgende schermopname ziet u een pagina met voorbeeldgegevensconnector, gemarkeerd met getallen die overeenkomen met belangrijke gebieden van de gebruikersinterface.

Schermopname van een pagina met voorbeeldgegevensconnector met secties met het label 1 tot en met 9.

Elk van de volgende elementen van de connectorUiConfig sectie die nodig is om de gebruikersinterface te configureren, komt overeen met het gedeelte CustomizableConnectorUiConfig van de API.

Veld	Verplicht	Typologie	Beschrijving	Schermopname van een opmerkelijk gebied #
titel	Klopt	touw	Titel weergegeven op de pagina gegevensconnector	1
ID		touw	Hiermee stelt u de aangepaste connector-id in voor intern gebruik
logo		touw	Pad naar afbeeldingsbestand in SVG-indeling. Als er geen waarde is geconfigureerd, wordt een standaardlogo gebruikt.	2
uitgever	Klopt	touw	De provider van de connector	3
descriptionMarkdown	Klopt	tekenreeks in Markdown	Een beschrijving voor de connector met de mogelijkheid om markdown-taal toe te voegen om deze te verbeteren.	4
sampleQueries	Klopt	Geneste JSON sampleQueries	Query's voor de klant om te begrijpen hoe u de gegevens in het gebeurtenislogboek kunt vinden.
graphQueries	Klopt	Geneste JSON graphQueries	Query's die gegevensopname in de afgelopen twee weken presenteren. Geef één query op voor alle gegevenstypen van de gegevensconnector of een andere query voor elk gegevenstype.	5
graphQueriesTableName		Hiermee stelt u de naam van de tabel in waarnaar de connector gegevens invoegt. Deze naam kan worden gebruikt in andere query's door een tijdelijke aanduiding in `{{graphQueriesTableName}}` en `graphQueries` waarden op te `lastDataReceivedQuery` geven.
Datatypes	Klopt	Geneste JSON Datatypes	Een lijst met alle gegevenstypen voor uw connector en een query voor het ophalen van de tijd van de laatste gebeurtenis voor elk gegevenstype.	6
connectiviteitscriteria	Klopt	Geneste JSON connectiviteitscriteria	Een object dat definieert hoe u controleert of de connector is verbonden.	7
beschikbaarheid		Geneste JSON beschikbaarheid	Een object dat de beschikbaarheidsstatus van de connector definieert.
Machtigingen	Klopt	Geneste JSON Machtigingen	De informatie die wordt weergegeven in de sectie Vereisten van de gebruikersinterface, waarin de machtigingen worden vermeld die nodig zijn om de connector in of uit te schakelen.	8
instructionSteps	Klopt	Geneste JSON Instructies	Een matrix met widgetonderdelen die uitleggen hoe u de connector installeert en besturingselementen waarop actie kan worden uitgevoerd die worden weergegeven op het tabblad Instructies .	9
isConnectivityCriteriasMatchSome		Booleaan	Een Booleaanse waarde die aangeeft of 'OR'(SOME) of 'AND' moet worden gebruikt tussen ConnectivityCriteria-items.

connectiviteitCriteria

Veld	Verplicht	Typologie	Beschrijving
Typologie	Klopt	Snaar / Touwtje	Een van de volgende opties: `HasDataConnectors` deze waarde is het beste voor API-pollinggegevensconnectors zoals de CCF. De connector wordt beschouwd als verbonden met ten minste één actieve verbinding. `isConnectedQuery` – deze waarde is het meest geschikt voor andere typen gegevensconnectors. De connector wordt beschouwd als verbonden wanneer de opgegeven query gegevens retourneert.
Waarde	Waar wanneer het type is `isConnectedQuery`	Snaar / Touwtje	Een query om te bepalen of gegevens binnen een bepaalde periode worden ontvangen. Bijvoorbeeld: `CommonSecurityLog \| where DeviceVendor == \"Vectra Networks\"\n\| where DeviceProduct == \"X Series\"\n \| summarize LastLogReceived = max(TimeGenerated)\n \| project IsConnected = LastLogReceived > ago(7d)"`

Datatypes

Matrixwaarde	Typologie	Beschrijving
naam	Snaar / Touwtje	Een zinvolle beschrijving voor de`lastDataReceivedQuery` variabele, inclusief ondersteuning voor de `graphQueriesTableName` variabele. Voorbeeld: `{{graphQueriesTableName}}`
lastDataReceivedQuery	Snaar / Touwtje	Een KQL-query die één rij retourneert en de laatste keer dat gegevens zijn ontvangen, of geen gegevens als er geen resultaten zijn. Voorbeeld: `{{graphQueriesTableName}}\n \| summarize Time = max(TimeGenerated)\n \| where isnotempty(Time)`

graphQueries

Hiermee definieert u een query die gegevensopname in de afgelopen twee weken weergeeft.

Geef één query op voor alle gegevenstypen van de gegevensconnector of een andere query voor elk gegevenstype.

Matrixwaarde	Typologie	Beschrijving
metricName	Snaar / Touwtje	Een betekenisvolle naam voor uw grafiek. Voorbeeld: `Total data received`
legende	Snaar / Touwtje	De tekenreeks die in de legenda rechts van de grafiek wordt weergegeven, inclusief een verwijzing naar een variabele. Voorbeeld: `{{graphQueriesTableName}}`
baseQuery	Snaar / Touwtje	De query die filtert op relevante gebeurtenissen, inclusief een variabelereferentie. Voorbeeld: `TableName_CL \| where ProviderName == "myprovider"` of `{{graphQueriesTableName}}`

availability

Veld	Verplicht	Typologie	Beschrijving
status		Integer	De beschikbaarheidsstatus van de connector. Beschikbaar = 1 Functievlag = 2 Binnenkort beschikbaar = 3 Intern = 4
isPreview		Booleaan	Een Booleaanse waarde die aangeeft of de connector zich in de preview-modus bevindt.

Machtigingen

Matrixwaarde	Typologie	Beschrijving
douane	Snaar / Touwtje	Beschrijft eventuele aangepaste machtigingen die vereist zijn voor uw gegevensverbinding, in de volgende syntaxis: `{` `"name":`tekenreeks`,` `"description":`snaar `}` Voorbeeld: De gebruikerswaarde wordt weergegeven in de sectie Vereisten van Microsoft Sentinel met een blauw informatiepictogram. In het GitHub-voorbeeld correleert deze waarde met de persoonlijke tokensleutel van de GitHub-API: u hebt toegang nodig tot het persoonlijke GitHub-token...
Licenties	ENUM	Definieert de vereiste licenties als een van de volgende waarden: `OfficeIRM`,`OfficeATP`, `Office365`, , `AadP1P2`, `Mcas`, `Aatp`, `Mdatp`, , `MtpIoT` Voorbeeld: De licentiewaarde wordt weergegeven in Microsoft Sentinel als: Licentie: Vereiste Azure AD Premium P2
resourceProvider	resourceProvider	Beschrijft eventuele vereisten voor uw Azure-resource. Voorbeeld: De waarde resourceProvider wordt weergegeven in de sectie Vereisten voor Microsoft Sentinel als: Werkruimte: lees- en schrijfmachtiging is vereist. Sleutels: leesmachtigingen voor gedeelde sleutels voor de werkruimte zijn vereist.
huurder	matrix van ENUM-waarden Voorbeeld: `"tenant": [` `"GlobalADmin",` `"SecurityAdmin"` `]`	Definieert de vereiste machtigingen als een of meer van de volgende waarden: `"GlobalAdmin"`, `"SecurityAdmin"`, `"SecurityReader"`, `"InformationProtection"` Voorbeeld: geeft de tenantwaarde in Microsoft Sentinel weer als: Tenantmachtigingen: Vereist `Global Administrator` of `Security Administrator` op de tenant van de werkruimte

Belangrijk

Microsoft raadt u aan rollen te gebruiken met de minste machtigingen. Dit helpt de beveiliging voor uw organisatie te verbeteren. Globale beheerder is een zeer bevoorrechte rol die moet worden beperkt tot scenario's voor noodgevallen wanneer u geen bestaande rol kunt gebruiken.

hulpbronnenleverancier

subarraywaarde	Typologie	Beschrijving
aanbieder	ENUM	Beschrijft de resourceprovider, met een van de volgende waarden: - `Microsoft.OperationalInsights/workspaces` - `Microsoft.OperationalInsights/solutions` - `Microsoft.OperationalInsights/workspaces/datasources` - `microsoft.aadiam/diagnosticSettings` - `Microsoft.OperationalInsights/workspaces/sharedKeys` - `Microsoft.Authorization/policyAssignments`
providerDisplayName	Snaar / Touwtje	Een lijstitem onder Vereisten met een rood 'x' of groen vinkje wanneer de requiredPermissions worden gevalideerd op de connectorpagina. Voorbeeld `"Workspace"`
permissionsDisplayText	Snaar / Touwtje	Tekst weergeven voor lees-, schrijf- of lees- en schrijfmachtigingen die moeten overeenkomen met de waarden die zijn geconfigureerd in requiredPermissions
requiredPermissions	`{` `"action":`Booleaans`,` `"delete":`Booleaans`,` `"read":`Booleaans`,` `"write":`Booleaans `}`	Beschrijft de minimale machtigingen die vereist zijn voor de connector.
draagwijdte	ENUM	Beschrijft het bereik van de gegevensconnector als een van de volgende waarden: `"Subscription"`, , `"ResourceGroup""Workspace"`

sampleQueries

matrixwaarde	Typologie	Beschrijving
beschrijving	Snaar / Touwtje	Een zinvolle beschrijving voor de voorbeeldquery. Voorbeeld: `Top 10 vulnerabilities detected`
vraag	Snaar / Touwtje	Voorbeeldquery die wordt gebruikt om de gegevens van het gegevenstype op te halen. Voorbeeld: `{{graphQueriesTableName}}\n \| sort by TimeGenerated\n \| take 10`

Andere koppelingsopties configureren

Als u een inlinekoppeling wilt definiëren met behulp van Markdown, gebruikt u het volgende voorbeeld.

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

Als u een koppeling wilt definiëren als een ARM-sjabloon, gebruikt u het volgende voorbeeld als richtlijn:

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

Deze sectie bevat parameters die de set instructies definiëren die worden weergegeven op de pagina van uw gegevensconnector in Microsoft Sentinel en heeft de volgende structuur:

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

Array-eigenschap	Verplicht	Typologie	Beschrijving
titel		Snaar / Touwtje	Definieert een titel voor uw instructies.
beschrijving		Snaar / Touwtje	Definieert een beschrijvende beschrijving voor uw instructies.
innerSteps		Array	Definieert een matrix van interne instructiestappen.
Instructies	Klopt	Matrix met instructies	Hiermee definieert u een matrix met instructies van een specifiek parametertype.

aanwijzingen

Geeft een groep instructies weer, met verschillende parameters en de mogelijkheid om meer instructiesteps in groepen te nesten. Parameters die hier zijn gedefinieerd, komen overeen

Typologie	Array-eigenschap	Beschrijving
OAuthForm	OAuthForm	Verbinding maken met OAuth
tekstvak	tekstvak	Deze paren met `ConnectionToggleButton`. Er zijn vier beschikbare typen: `password` `text` `number` `email`
ConnectionToggleButton	ConnectionToggleButton	Activeer de implementatie van de DCR op basis van de verbindingsgegevens die zijn opgegeven via tijdelijke aanduidingsparameters. De volgende parameters worden ondersteund: `name` :verplicht `disabled` `isPrimary` `connectLabel` `disconnectLabel`
CopyableLabel	CopyableLabel	Toont een tekstveld met een knop Kopiëren aan het einde. Wanneer de knop is geselecteerd, wordt de waarde van het veld gekopieerd.
Vervolgkeuzelijst	Vervolgkeuzelijst	Geeft een vervolgkeuzelijst weer met opties waaruit de gebruiker kan kiezen.
Markdown	Markdown	Geeft een sectie weer van tekst die is opgemaakt met Markdown.
DataConnectorsGrid	DataConnectorsGrid	Geeft een raster weer van gegevensconnectors.
Contextvenster	Contextvenster	Geeft een contextueel informatievenster weer.
InfoMessage	InfoMessage	Definieert een inline informatiebericht.
InstructionStepsGroup	InstructionStepsGroup	Geeft een groep instructies weer, eventueel uitgevouwen of samenvouwbaar, in een afzonderlijke sectie met instructies.
InstallAgent	InstallAgent	Geeft een koppeling weer naar andere gedeelten van Azure om aan verschillende installatievereisten te voldoen.

OAuthForm

Dit onderdeel vereist dat het OAuth2 type aanwezig is in de auth eigenschap van de gegevensconnectorsjabloon.

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

Tekstvak

Hier volgen enkele voorbeelden van het Textbox type. Deze voorbeelden komen overeen met de parameters die worden gebruikt in de voorbeeldsectie auth in de naslaginformatie over gegevensconnectors voor het Codeless Connector Framework. Voor elk van de vier typen heeft elk type label, placeholderen 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"
  }          
}
]

KopieerbaarLabel

Voorbeeld:

Schermopname van de knop Waarde kopiëren in een veld.

voorbeeldcode:

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

Matrixwaarde	Verplicht	Typologie	Beschrijving
fillWith		ENUM	Reeks van omgevingsvariabelen die worden gebruikt om een tijdelijke aanduiding in te vullen. Scheid meerdere tijdelijke aanduidingen met komma's. Bijvoorbeeld: `{0},{1}` Ondersteunde waarden: `workspaceId`, `workspaceName`, `primaryKey`, , `MicrosoftAwsAccountsubscriptionId`
etiket	Klopt	Snaar / Touwtje	Hiermee definieert u de tekst voor het label boven een tekstvak.
waarde	Klopt	Snaar / Touwtje	Definieert de waarde die in het tekstvak moet worden weergegeven, ondersteunt tijdelijke aanduidingen.
Rijen		Rijen	Hiermee definieert u de rijen in het gebied van de gebruikersinterface. Standaard ingesteld op 1.
wideLabel		Booleaan	Bepaalt een breed label voor lange tekenreeksen. Standaard ingesteld op `false`.

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

Veld	Verplicht	Typologie	Beschrijving
etiket	Klopt	Snaar / Touwtje	Hiermee definieert u de tekst voor het label boven de vervolgkeuzelijst.
naam	Klopt	Snaar / Touwtje	Hiermee definieert u de unieke naam voor de vervolgkeuzelijst. Dit wordt gebruikt in de polling-configuratie.
Opties	Klopt	Array	Hiermee definieert u de lijst met opties voor de vervolgkeuzelijst.
Tijdelijke aanduiding		Snaar / Touwtje	Hiermee definieert u de tekst van de tijdelijke aanduiding voor de vervolgkeuzelijst.
isMultiSelect		Booleaan	Bepaalt of er meerdere opties kunnen worden geselecteerd. Standaard ingesteld op `false`.
Vereist		Booleaan	Als `true`de vervolgkeuzelijst moet worden ingevuld.
defaultAllSelected		Booleaan	Als `true`, alle opties zijn standaard geselecteerd.

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

Veld	Verplicht	Typologie	Beschrijving
kartering	Klopt	Array	Hiermee definieert u de toewijzing van kolommen in het raster.
menuItems		Array	Hiermee definieert u de menu-items voor het raster.

Contextvenster

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

Veld	Verplicht	Typologie	Beschrijving
titel	Klopt	Snaar / Touwtje	De titel voor het contextvenster.
Ondertitel	Klopt	Snaar / Touwtje	De ondertitel voor het contextvenster.
contextPaneType	Klopt	Snaar / Touwtje	Het type van het contextvenster.
instructionSteps	Klopt	Array instructionSteps	De instructiestappen voor het contextvenster.
etiket		Snaar / Touwtje	Het label voor het contextvenster.
isPrimary		Booleaan	Geeft aan of dit het primaire contextvenster is.

InfoMessage

Hier volgt een voorbeeld van een inline informatiebericht:

Schermopname van een inline-informatiebericht.

In de volgende afbeelding ziet u daarentegen een informatiebericht dat niet inline is:

Schermopname van een informatiebericht dat niet inline is.

Matrixwaarde	Typologie	Beschrijving
tekst	Snaar / Touwtje	Definieer de tekst die in het bericht moet worden weergegeven.
zichtbaar	Booleaan	Bepaalt of het bericht wordt weergegeven.
Inline	Booleaan	Bepaalt hoe het informatiebericht wordt weergegeven. - `true`: (Aanbevolen) Toont het informatiebericht dat is ingesloten in de instructies. - `false`: Voegt een blauwe achtergrond toe.

InstructionStepsGroup

Hier volgt een voorbeeld van een uitbreidbare instructiegroep:

Schermopname van een uitbreidbare, extra instructiegroep.

Matrixwaarde	Verplicht	Typologie	Beschrijving
titel	Klopt	Snaar / Touwtje	Hiermee definieert u de titel voor de instructiestap.
beschrijving		Snaar / Touwtje	Optionele beschrijvende tekst.
canCollapseAllSections		Booleaan	Bepaalt of de sectie een samenvouwbare accordeon is of niet.
noFxPadding		Booleaan	Als `true`, vermindert de hoogte van de padding om de ruimte te besparen.
Uitgebreid		Booleaan	Als `true`, wordt standaard als uitgevouwen weergegeven.

Zie de configuratie-JSON voor de Windows DNS-connector voor een gedetailleerd voorbeeld.

InstallAgent

Sommige InstallAgent-typen worden weergegeven als een knop, andere worden weergegeven als een koppeling. Hier volgen voorbeelden van beide:

Schermopname van een koppeling die is toegevoegd als inlinetekst.

Matrixwaarden	Verplicht	Typologie	Beschrijving
linkType	Klopt	ENUM	Bepaalt het koppelingstype als een van de volgende waarden: `InstallAgentOnWindowsVirtualMachine` `InstallAgentOnWindowsNonAzure` `InstallAgentOnLinuxVirtualMachine` `InstallAgentOnLinuxNonAzure` `OpenSyslogSettings` `OpenCustomLogsSettings` `OpenWaf` `OpenAzureFirewall` `OpenMicrosoftAzureMonitoring` `OpenFrontDoors` `OpenCdnProfile` `AutomaticDeploymentCEF` `OpenAzureInformationProtection` `OpenAzureActivityLog` `OpenIotPricingModel` `OpenPolicyAssignment` `OpenAllAssignmentsBlade` `OpenCreateDataCollectionRule`
policyDefinitionGuid	Waar wanneer u linkType gebruikt `OpenPolicyAssignment` .	Snaar / Touwtje	Voor connectors op basis van beleid definieert u de GUID van de ingebouwde beleidsdefinitie.
assignMode		ENUM	Voor connectors op basis van beleid definieert u de toewijzingsmodus als een van de volgende waarden: `InitiativePolicy`
gegevensverzamelingsregeltype		ENUM	Voor connectors op basis van DCR definieert u het type regeltype voor gegevensverzameling als , `SecurityEvent`of `ForwardEvent`.

Voorbeeld van definitie van gegevensconnector

In het volgende voorbeeld worden enkele van de onderdelen die in dit artikel zijn gedefinieerd, samengevoegd als een JSON-hoofdtekstindeling voor gebruik met de definitie-API voor het maken of bijwerken van de gegevensconnector.

Bekijk connectorUiConfig voor meer voorbeelden. Zelfs connectors die gebruikmaken van de verouderde CCF, hebben geldige voorbeelden van het maken van de gebruikersinterface.

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

Feedback

Is deze pagina nuttig?

Last updated on 2025-10-31