Data Connector Definitions - Create Or Update

Serviço:: Sentinel

Versão da API:: 2025-09-01

Cria ou atualiza a definição do conector de dados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
dataConnectorDefinitionName	path	True	string pattern: ^[a-z0-9A-Z-_]*$	O nome da definição do conector de dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

CustomizableConnectorDefinition

Definição do conector para o tipo 'Personalizável'.

Name	Necessário	Tipo	Description
kind	True	string: Customizable	O tipo de conector de dados
properties.connectorUiConfig	True	CustomizableConnectorUiConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
etag		string	Etag do recurso azure
properties.connectionsConfig		CustomizableConnectionsConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
properties.createdTimeUtc		string (date-time)	Obtém ou define a data de criação da definição do conector no formato UTC.
properties.lastModifiedUtc		string (date-time)	Obtém ou define a data da última modificação da definição do conector no formato UTC.

Respostas

Name	Tipo	Description
200 OK	DataConnectorDefinition: CustomizableConnectorDefinition	Updated
201 Created	DataConnectorDefinition: CustomizableConnectorDefinition	Criado
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create data connector definition

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
              }
            }
          ]
        }
      ]
    }
  }
}

Código de estado:: 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"
              }
            }
          ]
        }
      ]
    }
  }
}

Definições

Name	Description
CloudError	Estrutura de resposta a erros.
CloudErrorBody	Detalhes do erro.
ConnectivityCriterion	Os critérios pelos quais determinamos se o conector está conectado ou não. Por exemplo, use uma consulta KQL para verificar se o tipo de dados esperado está fluindo).
ConnectorDataType	O tipo de dados que é criado pelo conector, incluindo uma consulta indicada quando foi a última vez que o tipo de dados foi recebido no espaço de trabalho.
ConnectorDefinitionsAvailability	O estado de exposição do conector aos clientes.
ConnectorDefinitionsPermissions	As permissões necessárias para o conector.
ConnectorDefinitionsResourceProvider	Os detalhes do provedor de recursos incluem as permissões necessárias para o usuário criar conexões. O usuário deve ter as permissões necessárias (Leitura\Gravação, ..) no escopo especificado ProviderPermissionsScope em relação ao provedor de recursos especificado.
createdByType	O tipo de identidade que criou o recurso.
CustomizableConnectionsConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
CustomizableConnectorDefinition	Definição do conector para o tipo 'Personalizável'.
CustomizableConnectorUiConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
CustomPermissionDetails	As permissões personalizadas necessárias para o conector.
DataConnectorDefinitionKind	O tipo de definições do conector de dados
GraphQuery	A consulta de gráfico para mostrar o volume de dados que chegam ao espaço de trabalho ao longo do tempo.
InstructionStep	Etapas de instrução para habilitar o conector.
InstructionStepDetails	Detalhes da etapa de instrução, a serem exibidos na seção Etapas de instruções na página do conector no Portal Sentinel.
ProviderPermissionsScope	O escopo no qual o usuário deve ter permissões, a fim de ser capaz de criar conexões.
ResourceProviderRequiredPermissions	Permissões necessárias para o provedor de recursos do conector que definem em ResourceProviders. Para obter mais informações sobre as permissões, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aqui</ver>.
systemData	Metadados referentes à criação e última modificação do recurso.

CloudError

Object

Estrutura de resposta a erros.

Name	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Object

Detalhes do erro.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

ConnectivityCriterion

Object

Os critérios pelos quais determinamos se o conector está conectado ou não. Por exemplo, use uma consulta KQL para verificar se o tipo de dados esperado está fluindo).

Name	Tipo	Description
type	string	Obtém ou define o tipo de conectividade.
value	string[]	Obtém ou define as consultas para verificar a conectividade.

ConnectorDataType

Object

O tipo de dados que é criado pelo conector, incluindo uma consulta indicada quando foi a última vez que o tipo de dados foi recebido no espaço de trabalho.

Name	Tipo	Description
lastDataReceivedQuery	string	Obtém ou define a consulta para indicar quando os dados relevantes foram recebidos pela última vez no espaço de trabalho.
name	string	Obtém ou define o nome do tipo de dados a ser exibido no gráfico.

ConnectorDefinitionsAvailability

Object

O estado de exposição do conector aos clientes.

Name	Tipo	Description
isPreview	boolean	Obtém ou define um valor que indica se o conector é visualização.
status	integer (int32)	O estado de exposição do conector aos clientes. Os valores disponíveis são 0-4 (0=Nenhum, 1=Disponível, 2=FeatureFlag, 3=Interno).

ConnectorDefinitionsPermissions

Object

As permissões necessárias para o conector.

Name	Tipo	Description
customs	CustomPermissionDetails[]	Obtém ou define as permissões alfandegárias necessárias para o usuário criar conexões.
licenses	string[]	Obtém ou define as licenças necessárias para o usuário criar conexões.
resourceProvider	ConnectorDefinitionsResourceProvider[]	Obtém ou define as permissões do provedor de recursos necessárias para o usuário criar conexões.
tenant	string[]	Obtém ou define as permissões de locatário necessárias para o conector.

ConnectorDefinitionsResourceProvider

Object

Os detalhes do provedor de recursos incluem as permissões necessárias para o usuário criar conexões. O usuário deve ter as permissões necessárias (Leitura\Gravação, ..) no escopo especificado ProviderPermissionsScope em relação ao provedor de recursos especificado.

Name	Tipo	Description
permissionsDisplayText	string	Obtém ou define o texto da descrição das permissões.
provider	string	Obtém ou define o nome do provedor.
providerDisplayName	string	Obtém ou define o nome de exibição do provedor de permissões.
requiredPermissions	ResourceProviderRequiredPermissions	Permissões necessárias para o provedor de recursos do conector que definem em ResourceProviders. Para obter mais informações sobre as permissões, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aqui</ver>.
scope	ProviderPermissionsScope	O escopo no qual o usuário deve ter permissões, a fim de ser capaz de criar conexões.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CustomizableConnectionsConfig

Object

O UiConfig para o tipo de definição de conector 'Personalizável'.

Name	Tipo	Description
templateSpecName	string	Obtém ou define o nome do modelo. O modelo inclui modelos ARM que podem ser criados pelo conector, geralmente serão os modelos ARM dataConnectors.
templateSpecVersion	string	Obtém ou define a versão do modelo.

CustomizableConnectorDefinition

Object

Definição do conector para o tipo 'Personalizável'.

Name	Tipo	Description
etag	string	Etag do recurso azure
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: Customizable	O tipo de conector de dados
name	string	O nome do recurso
properties.connectionsConfig	CustomizableConnectionsConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
properties.connectorUiConfig	CustomizableConnectorUiConfig	O UiConfig para o tipo de definição de conector 'Personalizável'.
properties.createdTimeUtc	string (date-time)	Obtém ou define a data de criação da definição do conector no formato UTC.
properties.lastModifiedUtc	string (date-time)	Obtém ou define a data da última modificação da definição do conector no formato UTC.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CustomizableConnectorUiConfig

Object

O UiConfig para o tipo de definição de conector 'Personalizável'.

Name	Tipo	Description
availability	ConnectorDefinitionsAvailability	O estado de exposição do conector aos clientes.
connectivityCriteria	ConnectivityCriterion[]	Obtém ou define a maneira como o conector verifica se o conector está conectado.
dataTypes	ConnectorDataType[]	Obtém ou define os tipos de dados para verificar os últimos dados recebidos.
descriptionMarkdown	string	Obtém ou define a descrição do conector no formato markdown.
graphQueries	GraphQuery[]	Obtém ou define as consultas de gráfico para mostrar o volume de dados atual ao longo do tempo.
id	string	Obtém ou define a ID do conector personalizado.
instructionSteps	InstructionStep[]	Obtém ou define as etapas de instrução para habilitar o conector.
isConnectivityCriteriasMatchSome	boolean	Obtém ou define um valor que indica se deve usar 'OR'(SOME) ou 'AND' entre os itens ConnectivityCriteria.
logo	string	Obtém ou define o logotipo do conector a ser usado ao exibir o conector na galeria do conector do Azure Sentinel. O valor do logotipo deve estar no formato SVG.
permissions	ConnectorDefinitionsPermissions	As permissões necessárias para o conector.
publisher	string	Obtém ou define o nome do editor do conector.
title	string	Obtém ou define o título da lâmina do conector.

CustomPermissionDetails

Object

As permissões personalizadas necessárias para o conector.

Name	Tipo	Description
description	string	Obtém ou define a descrição de permissões personalizadas.
name	string	Obtém ou define o nome das permissões personalizadas.

DataConnectorDefinitionKind

Enumeração

O tipo de definições do conector de dados

Valor	Description
Customizable

GraphQuery

Object

A consulta de gráfico para mostrar o volume de dados que chegam ao espaço de trabalho ao longo do tempo.

Name	Tipo	Description
baseQuery	string	Obtém ou define a consulta base para o gráfico. A consulta base é encapsulada pelo infra da interface do usuário do Sentinel com uma consulta KQL, que mede o volume ao longo do tempo.
legend	string	Obtém ou define a legenda para o gráfico.
metricName	string	Obtém ou define o nome da métrica que a consulta está verificando. Por exemplo: «Total de dados recebidos».

InstructionStep

Object

Etapas de instrução para habilitar o conector.

Name	Tipo	Description
description	string	Obtém ou define a descrição da etapa de instrução.
innerSteps	InstructionStep[]	Obtém ou define os detalhes das etapas de instrução internas. Por exemplo: a etapa de instrução 1 pode conter etapas de instrução internas: [etapa de instrução 1.1, etapa de instrução 1.2].
instructions	InstructionStepDetails[]	Obtém ou define os detalhes da etapa de instrução.
title	string	Obtém ou define o título da etapa de instrução.

InstructionStepDetails

Object

Detalhes da etapa de instrução, a serem exibidos na seção Etapas de instruções na página do conector no Portal Sentinel.

Name	Tipo	Description
parameters	object	Obtém ou define as configurações de parâmetros de tipo de instrução.
type	string	Obtém ou define o nome do tipo de instrução.

ProviderPermissionsScope

Enumeração

O escopo no qual o usuário deve ter permissões, a fim de ser capaz de criar conexões.

Valor	Description
Subscription
ResourceGroup
Workspace

ResourceProviderRequiredPermissions

Object

Permissões necessárias para o provedor de recursos do conector que definem em ResourceProviders. Para obter mais informações sobre as permissões, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aqui</ver>.

Name	Tipo	Description
action	boolean	Obtém ou define um valor que indica se a permissão é ações personalizadas (POST).
delete	boolean	Obtém ou define um valor que indica se a permissão é a ação de exclusão (DELETE).
read	boolean	Obtém ou define um valor que indica se a permissão é ação de leitura (GET).
write	boolean	Obtém ou define um valor que indica se a permissão é ação de gravação (PUT ou PATCH).

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Data Connector Definitions - Create Or Update

Parâmetros do URI

Corpo do Pedido

CustomizableConnectorDefinition

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Create data connector definition

Pedido de amostra

Resposta da amostra

Definições

CloudError

CloudErrorBody

ConnectivityCriterion

ConnectorDataType

ConnectorDefinitionsAvailability

ConnectorDefinitionsPermissions

ConnectorDefinitionsResourceProvider

createdByType

CustomizableConnectionsConfig

CustomizableConnectorDefinition

CustomizableConnectorUiConfig

CustomPermissionDetails

DataConnectorDefinitionKind

GraphQuery

InstructionStep

InstructionStepDetails

ProviderPermissionsScope

ResourceProviderRequiredPermissions

systemData