Udostępnij przez


Data Connector Definitions - Create Or Update

Tworzy lub aktualizuje definicję łącznika danych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dataConnectorDefinitionName
path True

string

pattern: ^[a-z0-9A-Z-_]*$

Nazwa definicji łącznika danych.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

workspaceName
path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

Nazwa obszaru roboczego.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

CustomizableConnectorDefinition

Definicja łącznika dla rodzaju "Dostosowywalny".

Nazwa Wymagane Typ Opis
kind True string:

Customizable

Rodzaj łącznika danych

properties.connectorUiConfig True

CustomizableConnectorUiConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

etag

string

Etag zasobu platformy Azure

properties.connectionsConfig

CustomizableConnectionsConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

properties.createdTimeUtc

string (date-time)

Pobiera lub ustawia datę utworzenia definicji łącznika w formacie UTC.

properties.lastModifiedUtc

string (date-time)

Pobiera lub ustawia datę ostatniej modyfikacji definicji łącznika w formacie UTC.

Odpowiedzi

Nazwa Typ Opis
200 OK DataConnectorDefinition:

CustomizableConnectorDefinition

Updated

201 Created DataConnectorDefinition:

CustomizableConnectorDefinition

Created

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create data connector definition

Przykładowe żądanie

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=2025-09-01

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CloudError

Struktura odpowiedzi na błąd.

CloudErrorBody

Szczegóły błędu.

ConnectivityCriterion

Kryteria, według których określamy, czy złącze jest podłączone, czy nie. Na przykład użyj zapytania KQL, aby sprawdzić, czy oczekiwany typ danych jest przepływowy).

ConnectorDataType

Typ danych utworzony przez łącznik, w tym zapytanie wskazujące, kiedy ostatni raz ten typ danych został odebrany w obszarze roboczym.

ConnectorDefinitionsAvailability

Stan ekspozycji łącznika dla klientów.

ConnectorDefinitionsPermissions

Wymagane uprawnienia dla łącznika.

ConnectorDefinitionsResourceProvider

Szczegóły dostawcy zasobów zawierają wymagane uprawnienia dla użytkownika do tworzenia połączeń. Użytkownik powinien mieć wymagane uprawnienia (Odczyt/Zapis, ..) w określonym zakresie ProviderPermissionsScope względem określonego dostawcy zasobów.

createdByType

Typ tożsamości, która utworzyła zasób.

CustomizableConnectionsConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

CustomizableConnectorDefinition

Definicja łącznika dla rodzaju "Dostosowywalny".

CustomizableConnectorUiConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

CustomPermissionDetails

Uprawnienia niestandardowe wymagane dla łącznika.

DataConnectorDefinitionKind

Rodzaj definicji łącznika danych

GraphQuery

Zapytanie grafu przedstawiające ilość danych docierających do obszaru roboczego w czasie.

InstructionStep

Instrukcje dotyczące włączania łącznika.

InstructionStepDetails

Szczegóły kroku instrukcji, które mają być wyświetlane w sekcji Kroki instrukcji na stronie łącznika w portalu usługi Sentinel.

ProviderPermissionsScope

Zakres, do którego użytkownik powinien mieć uprawnienia, aby móc tworzyć połączenia.

ResourceProviderRequiredPermissions

Wymagane uprawnienia dla dostawcy zasobów łącznika, które są definiowane w ResourceProviders. Aby uzyskać więcej informacji na temat uprawnień, zobacz <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">tutaj</zobacz>.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Struktura odpowiedzi na błąd.

Nazwa Typ Opis
error

CloudErrorBody

Dane o błędzie

CloudErrorBody

Szczegóły błędu.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

ConnectivityCriterion

Kryteria, według których określamy, czy złącze jest podłączone, czy nie. Na przykład użyj zapytania KQL, aby sprawdzić, czy oczekiwany typ danych jest przepływowy).

Nazwa Typ Opis
type

string

Pobiera lub ustawia typ łączności.

value

string[]

Pobiera lub ustawia zapytania dotyczące sprawdzania łączności.

ConnectorDataType

Typ danych utworzony przez łącznik, w tym zapytanie wskazujące, kiedy ostatni raz ten typ danych został odebrany w obszarze roboczym.

Nazwa Typ Opis
lastDataReceivedQuery

string

Pobiera lub ustawia zapytanie w celu wskazania, kiedy odpowiednie dane zostały ostatnio odebrane w obszarze roboczym.

name

string

Pobiera lub ustawia nazwę typu danych, która ma być wyświetlana na wykresie.

ConnectorDefinitionsAvailability

Stan ekspozycji łącznika dla klientów.

Nazwa Typ Opis
isPreview

boolean

Pobiera lub ustawia wartość wskazującą, czy łącznik jest w wersji zapoznawczej.

status

integer (int32)

Stan ekspozycji łącznika dla klientów. Dostępne wartości to 0-4 (0=Brak, 1=Dostępny, 2=Flaga funkcji, 3=Wewnętrzny).

ConnectorDefinitionsPermissions

Wymagane uprawnienia dla łącznika.

Nazwa Typ Opis
customs

CustomPermissionDetails[]

Pobiera lub ustawia uprawnienia celne wymagane przez użytkownika do tworzenia połączeń.

licenses

string[]

Pobiera lub ustawia licencje wymagane przez użytkownika do tworzenia połączeń.

resourceProvider

ConnectorDefinitionsResourceProvider[]

Pobiera lub ustawia uprawnienia dostawcy zasobów wymagane do tworzenia połączeń przez użytkownika.

tenant

string[]

Pobiera lub ustawia wymagane uprawnienia dzierżawy dla łącznika.

ConnectorDefinitionsResourceProvider

Szczegóły dostawcy zasobów zawierają wymagane uprawnienia dla użytkownika do tworzenia połączeń. Użytkownik powinien mieć wymagane uprawnienia (Odczyt/Zapis, ..) w określonym zakresie ProviderPermissionsScope względem określonego dostawcy zasobów.

Nazwa Typ Opis
permissionsDisplayText

string

Pobiera lub ustawia tekst opisu uprawnień.

provider

string

Pobiera lub ustawia nazwę dostawcy.

providerDisplayName

string

Pobiera lub ustawia nazwę wyświetlaną dostawcy uprawnień.

requiredPermissions

ResourceProviderRequiredPermissions

Wymagane uprawnienia dla dostawcy zasobów łącznika, które są definiowane w ResourceProviders. Aby uzyskać więcej informacji na temat uprawnień, zobacz <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">tutaj</zobacz>.

scope

ProviderPermissionsScope

Zakres, do którego użytkownik powinien mieć uprawnienia, aby móc tworzyć połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

Nazwa Typ Opis
templateSpecName

string

Pobiera lub ustawia nazwę szablonu. Szablon zawiera szablony usługi ARM, które można utworzyć za pomocą łącznika, zwykle będą to szablony usługi ARM dataConnectors.

templateSpecVersion

string

Pobiera lub ustawia wersję szablonu.

CustomizableConnectorDefinition

Definicja łącznika dla rodzaju "Dostosowywalny".

Nazwa Typ Opis
etag

string

Etag zasobu platformy Azure

id

string (arm-id)

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind string:

Customizable

Rodzaj łącznika danych

name

string

Nazwa zasobu

properties.connectionsConfig

CustomizableConnectionsConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

properties.connectorUiConfig

CustomizableConnectorUiConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

properties.createdTimeUtc

string (date-time)

Pobiera lub ustawia datę utworzenia definicji łącznika w formacie UTC.

properties.lastModifiedUtc

string (date-time)

Pobiera lub ustawia datę ostatniej modyfikacji definicji łącznika w formacie UTC.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

UiConfig dla rodzaju definicji łącznika "Dostosowywalny".

Nazwa Typ Opis
availability

ConnectorDefinitionsAvailability

Stan ekspozycji łącznika dla klientów.

connectivityCriteria

ConnectivityCriterion[]

Pobiera lub ustawia sposób, w jaki łącznik sprawdza, czy łącznik jest połączony.

dataTypes

ConnectorDataType[]

Pobiera lub ustawia typy danych do sprawdzania ostatnich odebranych danych.

descriptionMarkdown

string

Pobiera lub ustawia opis łącznika w formacie markdown.

graphQueries

GraphQuery[]

Pobiera lub ustawia zapytania wykresu tak, aby pokazywały bieżącą ilość danych w czasie.

id

string

Pobiera lub ustawia identyfikator łącznika niestandardowego. Pole opcjonalne.

instructionSteps

InstructionStep[]

Pobiera lub ustawia kroki instrukcji w celu włączenia łącznika.

isConnectivityCriteriasMatchSome

boolean

Pobiera lub ustawia wartość wskazującą, czy użyć wartości "OR" (SOME) lub "AND" między elementami ConnectivityCriteria.

logo

string

Pobiera lub ustawia logo łącznika, które ma być używane podczas wyświetlania łącznika w galerii łącznika wskaźnikowego platformy Azure. Wartość logo powinna być w formacie SVG.

permissions

ConnectorDefinitionsPermissions

Wymagane uprawnienia dla łącznika.

publisher

string

Pobiera lub ustawia nazwę wydawcy łącznika.

title

string

Pobiera lub ustawia tytuł bloku łącznika.

CustomPermissionDetails

Uprawnienia niestandardowe wymagane dla łącznika.

Nazwa Typ Opis
description

string

Pobiera lub ustawia opis uprawnień niestandardowych.

name

string

Pobiera lub ustawia nazwę uprawnień niestandardowych.

DataConnectorDefinitionKind

Rodzaj definicji łącznika danych

Wartość Opis
Customizable

GraphQuery

Zapytanie grafu przedstawiające ilość danych docierających do obszaru roboczego w czasie.

Nazwa Typ Opis
baseQuery

string

Pobiera lub ustawia zapytanie podstawowe dla grafu. Zapytanie podstawowe jest opakowane przez interfejs użytkownika usługi Sentinel infra z zapytaniem KQL, które mierzy wolumin w czasie.

legend

string

Pobiera lub ustawia legendę dla wykresu.

metricName

string

Pobiera lub ustawia nazwę metryki sprawdzaną przez zapytanie. Na przykład: "Łączna liczba odebranych danych".

InstructionStep

Instrukcje dotyczące włączania łącznika.

Nazwa Typ Opis
description

string

Pobiera lub ustawia opis kroku instrukcji.

innerSteps

InstructionStep[]

Pobiera lub ustawia szczegóły kroków instrukcji wewnętrznej. Na przykład: krok instrukcji 1 może zawierać wewnętrzne kroki instrukcji: [krok instrukcji 1.1, krok instrukcji 1.2].

instructions

InstructionStepDetails[]

Pobiera lub ustawia szczegóły kroku instrukcji.

title

string

Pobiera lub ustawia tytuł kroku instrukcji.

InstructionStepDetails

Szczegóły kroku instrukcji, które mają być wyświetlane w sekcji Kroki instrukcji na stronie łącznika w portalu usługi Sentinel.

Nazwa Typ Opis
parameters

object

Pobiera lub ustawia ustawienia parametrów typu instrukcji.

type

string

Pobiera lub ustawia nazwę typu instrukcji.

ProviderPermissionsScope

Zakres, do którego użytkownik powinien mieć uprawnienia, aby móc tworzyć połączenia.

Wartość Opis
Subscription
ResourceGroup
Workspace

ResourceProviderRequiredPermissions

Wymagane uprawnienia dla dostawcy zasobów łącznika, które są definiowane w ResourceProviders. Aby uzyskać więcej informacji na temat uprawnień, zobacz <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">tutaj</zobacz>.

Nazwa Typ Opis
action

boolean

Pobiera lub ustawia wartość wskazującą, czy uprawnienie jest akcją niestandardową (POST).

delete

boolean

Pobiera lub ustawia wartość wskazującą, czy uprawnienie to akcja usuwania (DELETE).

read

boolean

Pobiera lub ustawia wartość wskazującą, czy uprawnienie jest akcją odczytu (GET).

write

boolean

Pobiera lub ustawia wartość wskazującą, czy uprawnienie jest akcją zapisu (PUT czy PATCH).

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.