Data Connector Definitions - Get

Служба:: Sentinel

Версия API:: 2025-09-01

Получает определение соединителя данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataConnectorDefinitionName	path	True	string pattern: ^[a-z0-9A-Z-_]*$	Имя определения соединителя данных.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Название рабочего пространства мониторов.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get customize data connector definition

Образец запроса

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

Пример ответа

Код состояния:: 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"
    }
  }
}

Определения

Имя	Описание
CloudError	Структура ответа на ошибку.
CloudErrorBody	Сведения об ошибке.
ConnectivityCriterion	Критерии, по которым мы определяем, подключен разъем или нет. Например, используйте запрос KQL для проверки того, является ли ожидаемый тип данных потоком.
ConnectorDataType	Тип данных, создаваемый соединителем, включая запрос, указывающий, когда этот тип данных был получен в последний раз в рабочей области.
ConnectorDefinitionsAvailability	Состояние уязвимости разъема для клиентов.
ConnectorDefinitionsPermissions	Необходимые разрешения для соединителя.
ConnectorDefinitionsResourceProvider	Сведения о поставщике ресурсов включают необходимые разрешения для пользователя на создание подключений. Пользователь должен иметь необходимые разрешения (Read\Write, ..) в указанной области ProviderPermissionsScope для указанного поставщика ресурсов.
createdByType	Тип удостоверения, создавшего ресурс.
CustomizableConnectionsConfig	UiConfig для типа определения коннектора 'Customizable'.
CustomizableConnectorDefinition	Определение коннектора для вида 'Customizable'.
CustomizableConnectorUiConfig	UiConfig для типа определения коннектора 'Customizable'.
CustomPermissionDetails	Пользовательские разрешения, необходимые для соединителя.
DataConnectorDefinitionKind	Тип определений соединителей данных
GraphQuery	Запрос графика, показывающий объем данных, поступающих в рабочую область с течением времени.
InstructionStep	Инструкция по включению разъема.
InstructionStepDetails	Подробные сведения о шагах инструкции, которые будут отображаться в разделе Шаги инструкций на странице соединителя в Sentinel Portal.
ProviderPermissionsScope	Область, в которой у пользователя должны быть разрешения, чтобы иметь возможность создавать подключения.
ResourceProviderRequiredPermissions	Необходимые разрешения для поставщика ресурсов соединителя, определенного в ResourceProviders. Для получения дополнительной информации о разрешениях смотрите <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">здесь</см>.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CloudError

Объект

Структура ответа на ошибку.

Имя	Тип	Описание
error	CloudErrorBody	Данные об ошибках

CloudErrorBody

Объект

Сведения об ошибке.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

ConnectivityCriterion

Объект

Критерии, по которым мы определяем, подключен разъем или нет. Например, используйте запрос KQL для проверки того, является ли ожидаемый тип данных потоком.

Имя	Тип	Описание
type	string	Получает или задает тип подключения.
value	string[]	Получает или задает запросы для проверки связности.

ConnectorDataType

Объект

Тип данных, создаваемый соединителем, включая запрос, указывающий, когда этот тип данных был получен в последний раз в рабочей области.

Имя	Тип	Описание
lastDataReceivedQuery	string	Получает или задает запрос, указывающий, когда релевантные данные были в последний раз получены в рабочей области.
name	string	Получает или задает имя типа данных, отображаемого на диаграмме.

ConnectorDefinitionsAvailability

Объект

Состояние уязвимости разъема для клиентов.

Имя	Тип	Описание
isPreview	boolean	Получает или задает значение, указывающее, является ли соединитель предварительным просмотром.
status	integer (int32)	Состояние уязвимости разъема для клиентов. Доступные значения: 0-4 (0=Нет, 1=Доступно, 2=FeatureFlag, 3=Внутренний).

ConnectorDefinitionsPermissions

Объект

Необходимые разрешения для соединителя.

Имя	Тип	Описание
customs	CustomPermissionDetails[]	Получает или задает таможенные разрешения, необходимые пользователю для создания подключений.
licenses	string[]	Получает или задает необходимые лицензии для пользователя для создания подключений.
resourceProvider	ConnectorDefinitionsResourceProvider[]	Получает или задает разрешения поставщика ресурсов, необходимые пользователю для создания подключений.
tenant	string[]	Получает или задает необходимые разрешения клиента для соединителя.

ConnectorDefinitionsResourceProvider

Объект

Сведения о поставщике ресурсов включают необходимые разрешения для пользователя на создание подключений. Пользователь должен иметь необходимые разрешения (Read\Write, ..) в указанной области ProviderPermissionsScope для указанного поставщика ресурсов.

Имя	Тип	Описание
permissionsDisplayText	string	Получает или задает текст описания разрешений.
provider	string	Получает или задает имя поставщика.
providerDisplayName	string	Получает или задает отображаемое имя поставщика разрешений.
requiredPermissions	ResourceProviderRequiredPermissions	Необходимые разрешения для поставщика ресурсов соединителя, определенного в ResourceProviders. Для получения дополнительной информации о разрешениях смотрите <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">здесь</см>.
scope	ProviderPermissionsScope	Область, в которой у пользователя должны быть разрешения, чтобы иметь возможность создавать подключения.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

Объект

UiConfig для типа определения коннектора 'Customizable'.

Имя	Тип	Описание
templateSpecName	string	Получает или задает имя шаблона. Шаблон включает в себя шаблоны ARM, которые могут быть созданы коннектором, обычно это будут шаблоны ARM dataConnectors.
templateSpecVersion	string	Получает или задает версию шаблона.

CustomizableConnectorDefinition

Объект

Определение коннектора для вида 'Customizable'.

Имя	Тип	Описание
etag	string	Etag ресурса Azure
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: Customizable	Метаданные, используемые порталом или инструментом/т. д., для отображения различных интерфейсов взаимодействия с ресурсами одного типа; Например, ApiApps — это тип Microsoft.Web/sites. При поддержке поставщик ресурсов должен проверить и сохранить это значение.
name	string	Имя ресурса
properties.connectionsConfig	CustomizableConnectionsConfig	UiConfig для типа определения коннектора 'Customizable'.
properties.connectorUiConfig	CustomizableConnectorUiConfig	UiConfig для типа определения коннектора 'Customizable'.
properties.createdTimeUtc	string (date-time)	Получает или задает дату создания определения соединителя в формате UTC.
properties.lastModifiedUtc	string (date-time)	Получает или задает дату последнего изменения определения соединителя в формате UTC.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

Объект

UiConfig для типа определения коннектора 'Customizable'.

Имя	Тип	Описание
availability	ConnectorDefinitionsAvailability	Состояние уязвимости разъема для клиентов.
connectivityCriteria	ConnectivityCriterion[]	Получает или задает способ, которым соединитель проверяет, подключен ли разъем.
dataTypes	ConnectorDataType[]	Получает или задает типы данных для проверки последних полученных данных.
descriptionMarkdown	string	Получает или задает описание коннектора в формате markdown.
graphQueries	GraphQuery[]	Получает или задает графические запросы для отображения текущего объема данных с течением времени.
id	string	Получает или задает пользовательский идентификатор соединителя. необязательное поле.
instructionSteps	InstructionStep[]	Получает или задает инструкции по включению соединителя.
isConnectivityCriteriasMatchSome	boolean	Получает или задает значение, указывающее, следует ли использовать 'OR' (SOME) или 'И' между элементами ConnectivityCriteria.
logo	string	Получает или задает логотип соединителя, который будет использоваться при отображении соединителя в коллекции соединителя Azure Sentinel. Значение логотипа должно быть в формате SVG.
permissions	ConnectorDefinitionsPermissions	Необходимые разрешения для соединителя.
publisher	string	Получает или задает имя издателя соединителя.
title	string	Получает или задает заголовок соединительного лезвия.

CustomPermissionDetails

Объект

Пользовательские разрешения, необходимые для соединителя.

Имя	Тип	Описание
description	string	Получает или задает пользовательское описание разрешений.
name	string	Получает или задает имя пользовательских разрешений.

DataConnectorDefinitionKind

Перечисление

Тип определений соединителей данных

Значение	Описание
Customizable	Настраивается

GraphQuery

Объект

Запрос графика, показывающий объем данных, поступающих в рабочую область с течением времени.

Имя	Тип	Описание
baseQuery	string	Получает или задает базовый запрос для графа. Базовый запрос упаковывается инфраструктурой пользовательского интерфейса Sentinel с запросом KQL, который измеряет объем с течением времени.
legend	string	Получает или задает условные обозначения для графика.
metricName	string	Получает или задает имя метрики, которое проверяется запросом. Например: «Всего полученных данных».

InstructionStep

Объект

Инструкция по включению разъема.

Имя	Тип	Описание
description	string	Получает или задает описание шага инструкции.
innerSteps	InstructionStep[]	Получает или задает детали внутренних шагов инструкции. Например: шаг 1 инструкции может содержать внутренние шаги инструкции: [шаг 1.1, шаг 1.2].
instructions	InstructionStepDetails[]	Получает или задает детали шага инструкции.
title	string	Получает или задает заголовок шага инструкции.

InstructionStepDetails

Объект

Подробные сведения о шагах инструкции, которые будут отображаться в разделе Шаги инструкций на странице соединителя в Sentinel Portal.

Имя	Тип	Описание
parameters		Получает или задает настройки параметров типа инструкции.
type	string	Получает или задает имя типа инструкции.

ProviderPermissionsScope

Перечисление

Область, в которой у пользователя должны быть разрешения, чтобы иметь возможность создавать подключения.

Значение	Описание
Subscription	Subscription
ResourceGroup	ResourceGroup
Workspace	Workspace

ResourceProviderRequiredPermissions

Объект

Необходимые разрешения для поставщика ресурсов соединителя, определенного в ResourceProviders. Для получения дополнительной информации о разрешениях смотрите <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">здесь</см>.

Имя	Тип	Описание
action	boolean	Получает или задает значение, указывающее, является ли разрешение пользовательскими действиями (POST).
delete	boolean	Получает или задает значение, указывающее, является ли разрешение действием удаления (DELETE).
read	boolean	Получает или задает значение, указывающее, является ли разрешение действием чтения (GET).
write	boolean	Получает или устанавливает значение, указывающее, является ли разрешение действием записи (PUT или PATCH).

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.