Data Connector Definitions - Create Or Update
Crea o actualiza la definición del conector de datos.
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 de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
data
|
path | True |
string pattern: ^[a-z0-9A-Z-_]*$ |
Nombre de la definición del conector de datos. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
|
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
|
workspace
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ |
Nombre del área de trabajo. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
CustomizableConnectorDefinition
Definición de conector para el tipo 'Personalizable'.
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| kind | True |
string:
Customizable |
Tipo de conector de datos |
| properties.connectorUiConfig | True |
El tipo de definición de conector UiConfig para 'Personalizable'. |
|
| etag |
string |
Etag del recurso de Azure |
|
| properties.connectionsConfig |
El tipo de definición de conector UiConfig para 'Personalizable'. |
||
| properties.createdTimeUtc |
string (date-time) |
Obtiene o establece la fecha de creación de la definición del conector en formato UTC. |
|
| properties.lastModifiedUtc |
string (date-time) |
Obtiene o establece la fecha de la última modificación de la definición del conector en formato UTC. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK | DataConnectorDefinition: |
Actualizado |
| 201 Created | DataConnectorDefinition: |
Creado |
| Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| user_impersonation | suplantar la cuenta de usuario |
Ejemplos
Create data connector definition
Solicitud de ejemplo
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"
}
}
]
}
]
}
}
}
Respuesta de muestra
{
"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"
}
}
]
}
]
}
}
}
Definiciones
| Nombre | Description |
|---|---|
|
Cloud |
Estructura de respuesta de error. |
|
Cloud |
Detalles del error. |
|
Connectivity |
Los criterios por los que determinamos si el conector está conectado o no. Por ejemplo, use una consulta KQL para comprobar si el tipo de datos esperado está fluyendo). |
|
Connector |
El tipo de datos creado por el conector, incluida una consulta que indica cuándo fue la última vez que se recibió ese tipo de datos en el área de trabajo. |
|
Connector |
El estado de exposición del conector a los clientes. |
|
Connector |
Los permisos necesarios para el conector. |
|
Connector |
Los detalles del proveedor de recursos incluyen los permisos necesarios para que el usuario cree conexiones. El usuario debe tener los permisos necesarios (Lectura/Escritura, ..) en el ámbito especificado ProviderPermissionsScope en el proveedor de recursos especificado. |
|
created |
Tipo de identidad que creó el recurso. |
|
Customizable |
El tipo de definición de conector UiConfig para 'Personalizable'. |
|
Customizable |
Definición de conector para el tipo 'Personalizable'. |
|
Customizable |
El tipo de definición de conector UiConfig para 'Personalizable'. |
|
Custom |
Los permisos personalizados necesarios para el conector. |
|
Data |
El tipo de definiciones de conector de datos |
|
Graph |
Consulta de gráfico para mostrar el volumen de datos que llegan al área de trabajo a lo largo del tiempo. |
|
Instruction |
Pasos de instrucciones para habilitar el conector. |
|
Instruction |
Detalles del paso de instrucción, que se mostrarán en la sección Pasos de instrucciones en la página del conector en Sentinel Portal. |
|
Provider |
El ámbito en el que el usuario debe tener permisos para poder crear conexiones. |
|
Resource |
Permisos necesarios para el proveedor de recursos del conector que se define en ResourceProviders. Para obtener más información sobre los permisos, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aquí</ver>. |
|
system |
Metadatos relativos a la creación y última modificación del recurso. |
CloudError
Estructura de respuesta de error.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Datos de error |
CloudErrorBody
Detalles del error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación. |
| message |
string |
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario. |
ConnectivityCriterion
Los criterios por los que determinamos si el conector está conectado o no. Por ejemplo, use una consulta KQL para comprobar si el tipo de datos esperado está fluyendo).
| Nombre | Tipo | Description |
|---|---|---|
| type |
string |
Obtiene o establece el tipo de conectividad. |
| value |
string[] |
Obtiene o establece las consultas para comprobar la conectividad. |
ConnectorDataType
El tipo de datos creado por el conector, incluida una consulta que indica cuándo fue la última vez que se recibió ese tipo de datos en el área de trabajo.
| Nombre | Tipo | Description |
|---|---|---|
| lastDataReceivedQuery |
string |
Obtiene o establece la consulta para indicar cuándo se recibieron por última vez los datos relevantes en el área de trabajo. |
| name |
string |
Obtiene o establece el nombre del tipo de datos que se mostrará en el gráfico. |
ConnectorDefinitionsAvailability
El estado de exposición del conector a los clientes.
| Nombre | Tipo | Description |
|---|---|---|
| isPreview |
boolean |
Obtiene o establece un valor que indica si el conector es una vista previa. |
| status |
integer (int32) |
El estado de exposición del conector a los clientes. Los valores disponibles son 0-4 (0=Ninguno, 1=Disponible, 2=FeatureFlag, 3=Interno). |
ConnectorDefinitionsPermissions
Los permisos necesarios para el conector.
| Nombre | Tipo | Description |
|---|---|---|
| customs |
Obtiene o establece los permisos de aduana necesarios para que el usuario cree conexiones. |
|
| licenses |
string[] |
Obtiene o establece las licencias necesarias para que el usuario cree conexiones. |
| resourceProvider |
Obtiene o establece los permisos del proveedor de recursos necesarios para que el usuario cree conexiones. |
|
| tenant |
string[] |
Obtiene o establece los permisos de inquilino necesarios para el conector. |
ConnectorDefinitionsResourceProvider
Los detalles del proveedor de recursos incluyen los permisos necesarios para que el usuario cree conexiones. El usuario debe tener los permisos necesarios (Lectura/Escritura, ..) en el ámbito especificado ProviderPermissionsScope en el proveedor de recursos especificado.
| Nombre | Tipo | Description |
|---|---|---|
| permissionsDisplayText |
string |
Obtiene o establece el texto de descripción de los permisos. |
| provider |
string |
Obtiene o establece el nombre del proveedor. |
| providerDisplayName |
string |
Obtiene o establece el nombre para mostrar del proveedor de permisos. |
| requiredPermissions |
Permisos necesarios para el proveedor de recursos del conector que se define en ResourceProviders. Para obtener más información sobre los permisos, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aquí</ver>. |
|
| scope |
El ámbito en el que el usuario debe tener permisos para poder crear conexiones. |
createdByType
Tipo de identidad que creó el recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
CustomizableConnectionsConfig
El tipo de definición de conector UiConfig para 'Personalizable'.
| Nombre | Tipo | Description |
|---|---|---|
| templateSpecName |
string |
Obtiene o establece el nombre de la plantilla. La plantilla incluye plantillas de ARM que puede crear el conector, normalmente serán las plantillas de ARM dataConnectors. |
| templateSpecVersion |
string |
Obtiene o establece la versión de la plantilla. |
CustomizableConnectorDefinition
Definición de conector para el tipo 'Personalizable'.
| Nombre | Tipo | Description |
|---|---|---|
| etag |
string |
Etag del recurso de Azure |
| id |
string (arm-id) |
Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| kind |
string:
Customizable |
Tipo de conector de datos |
| name |
string |
Nombre del recurso |
| properties.connectionsConfig |
El tipo de definición de conector UiConfig para 'Personalizable'. |
|
| properties.connectorUiConfig |
El tipo de definición de conector UiConfig para 'Personalizable'. |
|
| properties.createdTimeUtc |
string (date-time) |
Obtiene o establece la fecha de creación de la definición del conector en formato UTC. |
| properties.lastModifiedUtc |
string (date-time) |
Obtiene o establece la fecha de la última modificación de la definición del conector en formato UTC. |
| systemData |
Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy. |
|
| type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
CustomizableConnectorUiConfig
El tipo de definición de conector UiConfig para 'Personalizable'.
| Nombre | Tipo | Description |
|---|---|---|
| availability |
El estado de exposición del conector a los clientes. |
|
| connectivityCriteria |
Obtiene o establece la forma en que el conector comprueba si está conectado. |
|
| dataTypes |
Obtiene o establece los tipos de datos para comprobar los últimos datos recibidos. |
|
| descriptionMarkdown |
string |
Obtiene o establece la descripción del conector en formato markdown. |
| graphQueries |
Obtiene o establece las consultas de gráficos para mostrar el volumen de datos actual a lo largo del tiempo. |
|
| id |
string |
Obtiene o establece el campo opcional de identificador de conector personalizado. |
| instructionSteps |
Obtiene o establece los pasos de instrucciones para habilitar el conector. |
|
| isConnectivityCriteriasMatchSome |
boolean |
Obtiene o establece un valor que indica si se debe usar "OR" (SOME) o "AND" entre los elementos ConnectivityCriteria. |
| logo |
string |
Obtiene o establece el logotipo del conector que se usará al mostrar el conector en la galería del conector de Azure Sentinel. El valor del logotipo debe estar en formato SVG. |
| permissions |
Los permisos necesarios para el conector. |
|
| publisher |
string |
Obtiene o establece el nombre del editor del conector. |
| title |
string |
Obtiene o establece el título de la hoja del conector. |
CustomPermissionDetails
Los permisos personalizados necesarios para el conector.
| Nombre | Tipo | Description |
|---|---|---|
| description |
string |
Obtiene o establece la descripción de los permisos personalizados. |
| name |
string |
Obtiene o establece el nombre de los permisos personalizados. |
DataConnectorDefinitionKind
El tipo de definiciones de conector de datos
| Valor | Description |
|---|---|
| Customizable |
GraphQuery
Consulta de gráfico para mostrar el volumen de datos que llegan al área de trabajo a lo largo del tiempo.
| Nombre | Tipo | Description |
|---|---|---|
| baseQuery |
string |
Obtiene o establece la consulta base para el gráfico. La consulta base se ajusta mediante la infraestructura de la interfaz de usuario de Sentinel con una consulta KQL, que mide el volumen a lo largo del tiempo. |
| legend |
string |
Obtiene o establece la leyenda del gráfico. |
| metricName |
string |
Obtiene o establece el nombre de la métrica que comprueba la consulta. Por ejemplo: 'Total de datos recibidos'. |
InstructionStep
Pasos de instrucciones para habilitar el conector.
| Nombre | Tipo | Description |
|---|---|---|
| description |
string |
Obtiene o establece la descripción del paso de instrucción. |
| innerSteps |
Obtiene o establece los detalles de los pasos de instrucción internos. Por ejemplo: el paso de instrucción 1 puede contener pasos de instrucción internos: [paso de instrucción 1.1, paso de instrucción 1.2]. |
|
| instructions |
Obtiene o establece los detalles del paso de instrucción. |
|
| title |
string |
Obtiene o establece el título del paso de instrucción. |
InstructionStepDetails
Detalles del paso de instrucción, que se mostrarán en la sección Pasos de instrucciones en la página del conector en Sentinel Portal.
| Nombre | Tipo | Description |
|---|---|---|
| parameters |
object |
Obtiene o establece la configuración de los parámetros de tipo de instrucción. |
| type |
string |
Obtiene o establece el nombre del tipo de instrucción. |
ProviderPermissionsScope
El ámbito en el que el usuario debe tener permisos para poder crear conexiones.
| Valor | Description |
|---|---|
| Subscription | |
| ResourceGroup | |
| Workspace |
ResourceProviderRequiredPermissions
Permisos necesarios para el proveedor de recursos del conector que se define en ResourceProviders. Para obtener más información sobre los permisos, consulte <href="https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#actions-format">aquí</ver>.
| Nombre | Tipo | Description |
|---|---|---|
| action |
boolean |
Obtiene o establece un valor que indica si el permiso es acciones personalizadas (POST). |
| delete |
boolean |
Obtiene o establece un valor que indica si el permiso es una acción de eliminación (DELETE). |
| read |
boolean |
Obtiene o establece un valor que indica si el permiso es una acción de lectura (GET). |
| write |
boolean |
Obtiene o establece un valor que indica si el permiso es una acción de escritura (PUT o PATCH). |
systemData
Metadatos relativos a la creación y última modificación del recurso.
| Nombre | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
Marca de tiempo de creación de recursos (UTC). |
| createdBy |
string |
Identidad que creó el recurso. |
| createdByType |
Tipo de identidad que creó el recurso. |
|
| lastModifiedAt |
string (date-time) |
Marca de tiempo de la última modificación del recurso (UTC) |
| lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
| lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |