Data Connector Definitions - Create Or Update

Reference

Služba:: Sentinel

Verze rozhraní API:: 2024-01-01-preview

Vytvoří nebo aktualizuje definici datového konektoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dataConnectorDefinitionName	path	True	string	Název definice datového konektoru. Vzor regulárního výrazu: `^[a-z0-9A-Z-_]*$`
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
workspaceName	path	True	string	Název pracovního prostoru. Vzor regulárního výrazu: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

CustomizableConnectorDefinition

Definice konektoru pro druh Přizpůsobitelné.

Name	Vyžadováno	Typ	Description
kind	True	string: Customizable	Druh datového konektoru
properties.connectorUiConfig	True	CustomizableConnectorUiConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
etag		string	Značka Etag prostředku Azure
properties.connectionsConfig		CustomizableConnectionsConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
properties.createdTimeUtc		string	Získá nebo nastaví datum vytvoření definice konektoru ve formátu UTC.
properties.lastModifiedUtc		string	Získá nebo nastaví datum poslední změny definice konektoru ve formátu UTC.

Odpovědi

Name	Typ	Description
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Aktualizováno
201 Created	DataConnectorDefinition: CustomizableConnectorDefinition	Vytvořeno
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create data connector definition

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2024-01-01-preview

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

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "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"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "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"
              }
            }
          ]
        }
      ]
    }
  }
}

Stavový kód:: 201

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "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"
        }
      ],
      "sampleQueries": [
        {
          "description": "All logs",
          "query": "GitHubAuditLogPolling_CL \n | take 10"
        }
      ],
      "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"
              }
            }
          ]
        }
      ]
    }
  }
}

Definice

Name	Description
CloudError	Struktura odezvy na chyby.
CloudErrorBody	Podrobnosti o chybě.
ConnectivityCriterion	Kritéria, podle kterých určujeme, jestli je konektor připojený nebo ne. Například pomocí dotazu KQL zkontrolujte, jestli je očekávaný datový typ tok.
ConnectorDataType	Datový typ vytvořený konektorem, včetně dotazu určeného, kdy byl tento datový typ v pracovním prostoru přijat naposledy.
ConnectorDefinitionsAvailability	Stav vystavení konektoru zákazníkům.
ConnectorDefinitionsPermissions	Požadovaná oprávnění pro konektor.
ConnectorDefinitionsResourceProvider	Podrobnosti o poskytovateli prostředků zahrnují požadovaná oprávnění pro uživatele k vytváření připojení. Uživatel by měl mít požadovaná oprávnění (Čtení\Zápis, ..) v zadaném oboru ProviderPermissionsScope vůči zadanému poskytovateli prostředků.
createdByType	Typ identity, která vytvořila prostředek.
CustomizableConnectionsConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
CustomizableConnectorDefinition	Definice konektoru pro druh Přizpůsobitelné.
CustomizableConnectorUiConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
CustomPermissionDetails	Vlastní oprávnění požadovaná pro konektor.
DataConnectorDefinitionKind	Druh definic datového konektoru
GraphQuery	Grafový dotaz zobrazující objem dat přicházejících do pracovního prostoru v průběhu času.
InstructionStep	Pokyny k povolení konektoru
InstructionStepDetails	Podrobnosti o kroku instrukce, které se zobrazí v části Kroky s pokyny na stránce konektoru na portálu Sentinel.
ProviderPermissionsScope	Obor, ke kterému by měl mít uživatel oprávnění, aby mohl vytvářet připojení.
ResourceProviderRequiredPermissions	Požadovaná oprávnění pro poskytovatele prostředků konektoru, který je definován v ResourceProviders. Další informace o oprávněních najdete tady.
systemData	Metadata týkající se vytvoření a poslední změny prostředku

CloudError

Struktura odezvy na chyby.

Name	Typ	Description
error	CloudErrorBody	Data o chybách

CloudErrorBody

Podrobnosti o chybě.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

ConnectivityCriterion

Kritéria, podle kterých určujeme, jestli je konektor připojený nebo ne. Například pomocí dotazu KQL zkontrolujte, jestli je očekávaný datový typ tok.

Name	Typ	Description
type	string	Získá nebo nastaví typ připojení.
value	string[]	Získá nebo nastaví dotazy pro kontrolu připojení.

ConnectorDataType

Datový typ vytvořený konektorem, včetně dotazu určeného, kdy byl tento datový typ v pracovním prostoru přijat naposledy.

Name	Typ	Description
lastDataReceivedQuery	string	Získá nebo nastaví dotaz tak, aby indikoval, kdy byla v pracovním prostoru naposledy přijata relevantní data.
name	string	Získá nebo nastaví název datového typu, který se zobrazí v grafu.

ConnectorDefinitionsAvailability

Stav vystavení konektoru zákazníkům.

Name	Typ	Description
isPreview	boolean	Získá nebo nastaví hodnotu označující, jestli je konektor ve verzi Preview.
status	integer	Stav vystavení konektoru zákazníkům. Dostupné hodnoty jsou 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).

ConnectorDefinitionsPermissions

Požadovaná oprávnění pro konektor.

Name	Typ	Description
customs	CustomPermissionDetails[]	Získá nebo nastaví celní oprávnění požadovaná pro uživatele k vytvoření připojení.
licenses	string[]	Získá nebo nastaví požadované licence pro uživatele k vytvoření připojení.
resourceProvider	ConnectorDefinitionsResourceProvider[]	Získá nebo nastaví oprávnění poskytovatele prostředků vyžadovaná pro vytvoření připojení uživatele.
tenant	string[]	Získá nebo nastaví požadovaná oprávnění tenanta pro konektor.

ConnectorDefinitionsResourceProvider

Podrobnosti o poskytovateli prostředků zahrnují požadovaná oprávnění pro uživatele k vytváření připojení. Uživatel by měl mít požadovaná oprávnění (Čtení\Zápis, ..) v zadaném oboru ProviderPermissionsScope vůči zadanému poskytovateli prostředků.

Name	Typ	Description
permissionsDisplayText	string	Získá nebo nastaví text popisu oprávnění.
provider	string	Získá nebo nastaví název zprostředkovatele.
providerDisplayName	string	Získá nebo nastaví zobrazovaný název zprostředkovatele oprávnění.
requiredPermissions	ResourceProviderRequiredPermissions	Požadovaná oprávnění pro poskytovatele prostředků konektoru, který je definován v ResourceProviders. Další informace o oprávněních najdete tady.
scope	ProviderPermissionsScope	Obor, ke kterému by měl mít uživatel oprávnění, aby mohl vytvářet připojení.

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomizableConnectionsConfig

Druh definice konektoru UiConfig pro přizpůsobitelné

Name	Typ	Description
templateSpecName	string	Získá nebo nastaví název šablony. Šablona obsahuje šablony ARM, které může konektor vytvořit, obvykle se jedná o šablony ARM dataConnectors.
templateSpecVersion	string	Získá nebo nastaví verzi šablony.

CustomizableConnectorDefinition

Definice konektoru pro druh Přizpůsobitelné.

Name	Typ	Description
etag	string	Značka Etag prostředku Azure
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: Customizable	Druh datového konektoru
name	string	Název prostředku
properties.connectionsConfig	CustomizableConnectionsConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
properties.connectorUiConfig	CustomizableConnectorUiConfig	Druh definice konektoru UiConfig pro přizpůsobitelné
properties.createdTimeUtc	string	Získá nebo nastaví datum vytvoření definice konektoru ve formátu UTC.
properties.lastModifiedUtc	string	Získá nebo nastaví datum poslední změny definice konektoru ve formátu UTC.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

CustomizableConnectorUiConfig

Druh definice konektoru UiConfig pro přizpůsobitelné

Name	Typ	Description
availability	ConnectorDefinitionsAvailability	Stav vystavení konektoru zákazníkům.
connectivityCriteria	ConnectivityCriterion[]	Získá nebo nastaví způsob, jakým konektor kontroluje, zda je konektor připojen.
dataTypes	ConnectorDataType[]	Získá nebo nastaví datové typy pro kontrolu naposledy přijatých dat.
descriptionMarkdown	string	Získá nebo nastaví popis konektoru ve formátu Markdown.
graphQueries	GraphQuery[]	Získá nebo nastaví grafové dotazy na zobrazení aktuálního objemu dat v průběhu času.
id	string	Získá nebo nastaví id vlastního konektoru. volitelné pole.
instructionSteps	InstructionStep[]	Získá nebo nastaví pokyny k povolení konektoru.
isConnectivityCriteriasMatchSome	boolean	Získá nebo nastaví hodnotu označující, zda použít 'OR'(SOME) nebo 'AND' mezi položkami ConnectivityCriteria.
logo	string	Získá nebo nastaví logo konektoru, které se má použít při zobrazení konektoru v galerii konektoru služby Azure Sentinel. Hodnota loga by měla být ve formátu SVG.
permissions	ConnectorDefinitionsPermissions	Požadovaná oprávnění pro konektor.
publisher	string	Získá nebo nastaví název vydavatele konektoru.
title	string	Získá nebo nastaví název okna konektoru.

CustomPermissionDetails

Vlastní oprávnění požadovaná pro konektor.

Name	Typ	Description
description	string	Získá nebo nastaví popis vlastních oprávnění.
name	string	Získá nebo nastaví vlastní název oprávnění.

DataConnectorDefinitionKind

Druh definic datového konektoru

Name	Typ	Description
Customizable	string

GraphQuery

Grafový dotaz zobrazující objem dat přicházejících do pracovního prostoru v průběhu času.

Name	Typ	Description
baseQuery	string	Získá nebo nastaví základní dotaz pro graf. Základní dotaz je zabalený do infrastruktury uživatelského rozhraní Služby Sentinel s dotazem KQL, který měří svazek v průběhu času.
legend	string	Získá nebo nastaví legendu pro graf.
metricName	string	Získá nebo nastaví název metriky, kterou dotaz kontroluje. Příklad: Celkový příjem dat.

InstructionStep

Pokyny k povolení konektoru

Name	Typ	Description
description	string	Získá nebo nastaví popis kroku instrukce.
innerSteps	InstructionStep[]	Získá nebo nastaví podrobnosti o krocích vnitřní instrukce. Příklad pro nepřítele: instrukce krok 1 může obsahovat vnitřní kroky instrukce: [instrukce krok 1.1, instrukce krok 1.2].
instructions	InstructionStepDetails[]	Získá nebo nastaví podrobnosti kroku instrukce.
title	string	Získá nebo nastaví název kroku instrukce.

InstructionStepDetails

Podrobnosti o kroku instrukce, které se zobrazí v části Kroky s pokyny na stránce konektoru na portálu Sentinel.

Name	Typ	Description
parameters	object	Získá nebo nastaví nastavení parametrů typu instrukce.
type	string	Získá nebo nastaví název typu instrukce.

ProviderPermissionsScope

Obor, ke kterému by měl mít uživatel oprávnění, aby mohl vytvářet připojení.

Name	Typ	Description
ResourceGroup	string
Subscription	string
Workspace	string

ResourceProviderRequiredPermissions

Požadovaná oprávnění pro poskytovatele prostředků konektoru, který je definován v ResourceProviders. Další informace o oprávněních najdete tady.

Name	Typ	Description
action	boolean	Získá nebo nastaví hodnotu označující, zda je oprávnění vlastní akce (POST).
delete	boolean	Získá nebo nastaví hodnotu označující, zda oprávnění je akce odstranění (DELETE).
read	boolean	Získá nebo nastaví hodnotu označující, zda oprávnění je akce čtení (GET).
write	boolean	Získá nebo nastaví hodnotu označující, zda oprávnění je akce zápisu (PUT nebo PATCH).

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Data Connector Definitions - Create Or Update

Parametry identifikátoru URI

Text požadavku

CustomizableConnectorDefinition

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create data connector definition

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

ConnectivityCriterion

ConnectorDataType

ConnectorDefinitionsAvailability

ConnectorDefinitionsPermissions

ConnectorDefinitionsResourceProvider

createdByType

CustomizableConnectionsConfig

CustomizableConnectorDefinition

CustomizableConnectorUiConfig

CustomPermissionDetails

DataConnectorDefinitionKind

GraphQuery

InstructionStep

InstructionStepDetails

ProviderPermissionsScope

ResourceProviderRequiredPermissions

systemData

Další materiály