Data Connector Definitions - Get

Referentie

Service:: Sentinel

API Version:: 2024-01-01-preview

Hiermee haalt u een definitie van een gegevensconnector op.

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

URI-parameters

Name	In	Vereist	Type	Description
dataConnectorDefinitionName	path	True	string	De naam van de definitie van de gegevensconnector. Regex pattern: `^[a-z0-9A-Z-_]*$`
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
workspaceName	path	True	string	De naam van de werkruimte. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Geslaagd
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get customize data connector definition

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12?api-version=2024-01-01-preview

Sample Response

Status code:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12",
  "type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
  "kind": "Customizable",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "connectorUiConfig": {
      "title": "GitHub Enterprise Audit Log",
      "publisher": "GitHub",
      "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.",
      "graphQueries": [
        {
          "metricName": "Total events received",
          "legend": "GitHub audit log events",
          "baseQuery": "GitHubAuditLogPolling_CL"
        }
      ],
      "dataTypes": [
        {
          "name": "GitHubAuditLogPolling_CL",
          "lastDataReceivedQuery": "GitHubAuditLogPolling_CL \n            | summarize Time = max(TimeGenerated)\n            | where isnotempty(Time)"
        }
      ],
      "connectivityCriteria": [
        {
          "type": "IsConnectedQuery",
          "value": [
            "GitHubAuditLogPolling_CL \n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
          ]
        }
      ],
      "availability": {
        "status": 1,
        "isPreview": false
      },
      "permissions": {
        "resourceProvider": [
          {
            "provider": "Microsoft.OperationalInsights/workspaces",
            "permissionsDisplayText": "read and write permissions are required.",
            "providerDisplayName": "Workspace",
            "scope": "Workspace",
            "requiredPermissions": {
              "write": true,
              "read": false,
              "delete": false,
              "action": false
            }
          }
        ],
        "customs": [
          {
            "name": "GitHub API personal token Key",
            "description": "You need access to GitHub personal token, the key should have 'admin:org' scope"
          }
        ]
      },
      "instructionSteps": [
        {
          "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel",
          "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key",
          "instructions": [
            {
              "type": "OAuthForm",
              "parameters": {
                "clientIdLabel": "Client ID",
                "clientSecretLabel": "Client Secret",
                "connectButtonLabel": "Connect",
                "disconnectButtonLabel": "Disconnect"
              }
            }
          ]
        }
      ]
    },
    "connectionsConfig": {
      "templateSpecName": "templateNameMock",
      "templateSpecVersion": "1.0.0"
    }
  }
}

Definities

Name	Description
CloudError	Structuur van foutreacties.
CloudErrorBody	Foutdetails.
ConnectivityCriterion	De criteria op basis waarvan we bepalen of de connector wel of niet is verbonden. Gebruik bijvoorbeeld een KQL-query om te controleren of het verwachte gegevenstype stroomt).
ConnectorDataType	Het gegevenstype dat door de connector wordt gemaakt, inclusief een query die aangeeft wanneer het gegevenstype voor het laatst is ontvangen in de werkruimte.
ConnectorDefinitionsAvailability	De blootstellingsstatus van de connector voor de klanten.
ConnectorDefinitionsPermissions	De vereiste machtigingen voor de connector.
ConnectorDefinitionsResourceProvider	De details van de resourceprovider bevatten de vereiste machtigingen voor de gebruiker om verbindingen te maken. De gebruiker moet de vereiste machtigingen (Lezen\Schrijven, ..) hebben in het opgegeven bereik ProviderPermissionsScope voor de opgegeven resourceprovider.
createdByType	Het type identiteit waarmee de resource is gemaakt.
CustomizableConnectionsConfig	Het definitietype UiConfig voor 'Aanpasbare' connector.
CustomizableConnectorDefinition	Definitie van connector voor soort 'Aanpasbaar'.
CustomizableConnectorUiConfig	Het definitietype UiConfig voor 'Aanpasbare' connector.
CustomPermissionDetails	De aangepaste machtigingen die zijn vereist voor de connector.
DataConnectorDefinitionKind	Het soort definities van de gegevensconnector
GraphQuery	De grafiekquery om de hoeveelheid gegevens weer te geven die in de loop van de tijd in de werkruimte binnenkomen.
InstructionStep	Instructiestappen voor het inschakelen van de connector.
InstructionStepDetails	Details van de instructiestap, die moeten worden weergegeven in de sectie Instructiesstappen op de pagina van de connector in de Sentinel-portal.
ProviderPermissionsScope	Het bereik waarvoor de gebruiker machtigingen moet hebben om verbindingen te kunnen maken.
ResourceProviderRequiredPermissions	Vereiste machtigingen voor de connectorresourceprovider die worden gedefinieerd in ResourceProviders. Zie hier voor meer informatie over de machtigingen.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

CloudError

Structuur van foutreacties.

Name	Type	Description
error	CloudErrorBody	Foutgegevens

CloudErrorBody

Foutdetails.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

ConnectivityCriterion

De criteria op basis waarvan we bepalen of de connector wel of niet is verbonden. Gebruik bijvoorbeeld een KQL-query om te controleren of het verwachte gegevenstype stroomt).

Name	Type	Description
type	string	Hiermee wordt het type connectiviteit opgehaald of ingesteld.
value	string[]	Hiermee worden de query's opgehaald of ingesteld voor het controleren van de connectiviteit.

ConnectorDataType

Het gegevenstype dat door de connector wordt gemaakt, inclusief een query die aangeeft wanneer het gegevenstype voor het laatst is ontvangen in de werkruimte.

Name	Type	Description
lastDataReceivedQuery	string	Hiermee wordt de query opgehaald of ingesteld om aan te geven wanneer relevante gegevens voor het laatst zijn ontvangen in de werkruimte.
name	string	Hiermee wordt de naam van het gegevenstype opgehaald of ingesteld dat in de grafiek moet worden weergegeven.

ConnectorDefinitionsAvailability

De blootstellingsstatus van de connector voor de klanten.

Name	Type	Description
isPreview	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de connector een preview-versie is.
status	integer	De blootstellingsstatus van de connector voor de klanten. Beschikbare waarden zijn 0-4 (0=Geen, 1=Beschikbaar, 2=FeatureFlag, 3=Intern).

ConnectorDefinitionsPermissions

De vereiste machtigingen voor de connector.

Name	Type	Description
customs	CustomPermissionDetails[]	Hiermee worden de vereiste douanemachtigingen opgehaald of ingesteld voor de gebruiker om verbindingen te maken.
licenses	string[]	Hiermee worden de vereiste licenties opgehaald of ingesteld voor de gebruiker om verbindingen te maken.
resourceProvider	ConnectorDefinitionsResourceProvider[]	Hiermee worden de machtigingen van de resourceprovider opgehaald of ingesteld die vereist zijn voor de gebruiker om verbindingen te maken.
tenant	string[]	Hiermee worden de vereiste tenantmachtigingen voor de connector opgehaald of ingesteld.

ConnectorDefinitionsResourceProvider

De details van de resourceprovider bevatten de vereiste machtigingen voor de gebruiker om verbindingen te maken. De gebruiker moet de vereiste machtigingen (Lezen\Schrijven, ..) hebben in het opgegeven bereik ProviderPermissionsScope voor de opgegeven resourceprovider.

Name	Type	Description
permissionsDisplayText	string	Hiermee wordt de beschrijvingstekst van de machtigingen opgehaald of ingesteld.
provider	string	Hiermee wordt de naam van de provider opgehaald of ingesteld.
providerDisplayName	string	Hiermee wordt de weergavenaam van de machtigingsprovider opgehaald of ingesteld.
requiredPermissions	ResourceProviderRequiredPermissions	Vereiste machtigingen voor de connectorresourceprovider die worden gedefinieerd in ResourceProviders. Zie hier voor meer informatie over de machtigingen.
scope	ProviderPermissionsScope	Het bereik waarvoor de gebruiker machtigingen moet hebben om verbindingen te kunnen maken.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomizableConnectionsConfig

Het definitietype UiConfig voor 'Aanpasbare' connector.

Name	Type	Description
templateSpecName	string	Hiermee wordt de sjabloonnaam opgehaald of ingesteld. De sjabloon bevat ARM-sjablonen die kunnen worden gemaakt door de connector, meestal zijn dit de dataConnectors ARM-sjablonen.
templateSpecVersion	string	Hiermee wordt de sjabloonversie opgehaald of ingesteld.

CustomizableConnectorDefinition

Definitie van connector voor soort 'Aanpasbaar'.

Name	Type	Description
etag	string	Etag van de Azure-resource
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: Customizable	Het type gegevensconnector
name	string	De naam van de resource
properties.connectionsConfig	CustomizableConnectionsConfig	Het definitietype UiConfig voor 'Aanpasbare' connector.
properties.connectorUiConfig	CustomizableConnectorUiConfig	Het definitietype UiConfig voor 'Aanpasbare' connector.
properties.createdTimeUtc	string	Hiermee wordt de datum opgehaald of ingesteld waarop de connectordefinitie is gemaakt in UTC-indeling.
properties.lastModifiedUtc	string	Hiermee wordt de connectordefinitie voor het laatst gewijzigd in UTC-indeling opgehaald of ingesteld.
systemData	systemData	Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CustomizableConnectorUiConfig

Het definitietype UiConfig voor 'Aanpasbare' connector.

Name	Type	Description
availability	ConnectorDefinitionsAvailability	De blootstellingsstatus van de connector voor de klanten.
connectivityCriteria	ConnectivityCriterion[]	Hiermee wordt de manier opgehaald of ingesteld waarop de connector controleert of de connector is verbonden.
dataTypes	ConnectorDataType[]	Hiermee worden de gegevenstypen opgehaald of ingesteld om te controleren op de laatste ontvangen gegevens.
descriptionMarkdown	string	Hiermee wordt de beschrijving van de connector opgehaald of ingesteld in markdown-indeling.
graphQueries	GraphQuery[]	Hiermee worden de grafiekquery's opgehaald of ingesteld om het huidige gegevensvolume in de loop van de tijd weer te geven.
id	string	Hiermee wordt de aangepaste connector-id opgehaald of ingesteld. optioneel veld.
instructionSteps	InstructionStep[]	Hiermee worden de instructiestappen opgehaald of ingesteld om de connector in te schakelen.
isConnectivityCriteriasMatchSome	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of 'OR'(SOME) of 'AND' moet worden gebruikt tussen ConnectivityCriteria-items.
logo	string	Hiermee wordt het connectorlogo opgehaald of ingesteld dat moet worden gebruikt bij het weergeven van de connector in de galerie van Azure Sentinel. De logowaarde moet de SVG-indeling hebben.
permissions	ConnectorDefinitionsPermissions	De vereiste machtigingen voor de connector.
publisher	string	Hiermee wordt de naam van de connectoruitgever opgehaald of ingesteld.
title	string	Hiermee wordt de titel van de connectorblade opgehaald of ingesteld.

CustomPermissionDetails

De aangepaste machtigingen die zijn vereist voor de connector.

Name	Type	Description
description	string	Hiermee wordt de beschrijving van de aangepaste machtigingen opgehaald of ingesteld.
name	string	Hiermee wordt de naam van de aangepaste machtigingen opgehaald of ingesteld.

DataConnectorDefinitionKind

Het soort definities van de gegevensconnector

Name	Type	Description
Customizable	string

GraphQuery

De grafiekquery om de hoeveelheid gegevens weer te geven die in de loop van de tijd in de werkruimte binnenkomen.

Name	Type	Description
baseQuery	string	Hiermee wordt de basisquery voor de grafiek opgehaald of ingesteld. De basisquery wordt verpakt door de Sentinel UI-infrastructuur met een KQL-query, die het volume in de loop van de tijd meet.
legend	string	Hiermee wordt de legenda voor de grafiek opgehaald of ingesteld.
metricName	string	Hiermee wordt de metrische naam opgehaald of ingesteld die door de query wordt gecontroleerd. Bijvoorbeeld: 'Totaal aantal ontvangen gegevens'.

InstructionStep

Instructiestappen voor het inschakelen van de connector.

Name	Type	Description
description	string	Hiermee wordt de beschrijving van de instructiestap opgehaald of ingesteld.
innerSteps	InstructionStep[]	Hiermee worden de details van de interne instructiestappen opgehaald of ingesteld. Voorbeeld van foe: instructie stap 1 kan interne instructiestappen bevatten: [instructiestap 1.1, instructiestap 1.2].
instructions	InstructionStepDetails[]	Haalt de details van de instructiestap op of stelt deze in.
title	string	Hiermee wordt de titel van de instructiestap opgehaald of ingesteld.

InstructionStepDetails

Details van de instructiestap, die moeten worden weergegeven in de sectie Instructiesstappen op de pagina van de connector in de Sentinel-portal.

Name	Type	Description
parameters	object	Hiermee worden de instellingen voor de instructietypeparameters opgehaald of ingesteld.
type	string	Hiermee wordt de naam van het instructietype opgehaald of ingesteld.

ProviderPermissionsScope

Het bereik waarvoor de gebruiker machtigingen moet hebben om verbindingen te kunnen maken.

Name	Type	Description
ResourceGroup	string
Subscription	string
Workspace	string

ResourceProviderRequiredPermissions

Vereiste machtigingen voor de connectorresourceprovider die worden gedefinieerd in ResourceProviders. Zie hier voor meer informatie over de machtigingen.

Name	Type	Description
action	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de machtiging Aangepaste acties (POST) is.
delete	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de machtiging verwijderactie (DELETE) is.
read	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de machtiging leesactie (GET) is.
write	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de machtiging schrijfactie is (PUT of PATCH).

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Delen via