Data Connector Definitions - List

Referencia

Service:: Sentinel

API Version:: 2024-01-01-preview

Obtiene todas las definiciones del conector de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	DataConnectorDefinitionArmCollectionWrapper	Correcto
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get all data connector definitions.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectorDefinitions?api-version=2024-01-01-preview

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
ConnectivityCriterion	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 fluye).
ConnectorDataType	El tipo de datos que crea el conector, incluida una consulta indicada cuando fue la última vez que se recibió el tipo de datos en el área de trabajo.
ConnectorDefinitionsAvailability	Estado de exposición del conector a los clientes.
ConnectorDefinitionsPermissions	Permisos 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 (Read\Write, ..) en el ámbito especificado ProviderPermissionsScope en el proveedor de recursos especificado.
createdByType	Tipo de identidad que creó el recurso.
CustomizableConnectionsConfig	UiConfig para el tipo de definición del conector "Personalizable".
CustomizableConnectorDefinition	Definición del conector para el tipo "Personalizable".
CustomizableConnectorUiConfig	UiConfig para el tipo de definición del conector "Personalizable".
CustomPermissionDetails	Permisos personalizados necesarios para el conector.
DataConnectorDefinitionArmCollectionWrapper	Encapsular el objeto de definición del conector de datos
DataConnectorDefinitionKind	El tipo de definiciones del conector de datos
GraphQuery	Consulta de gráfico para mostrar el volumen de datos que llegan al área de trabajo a lo largo del tiempo.
InstructionStep	Pasos de instrucción para habilitar el conector.
InstructionStepDetails	Detalles del paso de instrucción, que se mostrarán en la sección Pasos de instrucciones de la página del conector en El portal de Sentinel.
ProviderPermissionsScope	Ámbito en el que el usuario debe tener permisos para poder crear conexiones.
ResourceProviderRequiredPermissions	Permisos necesarios para el proveedor de recursos del conector que se definen en ResourceProviders. Para obtener más información sobre los permisos, consulte aquí.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

CloudError

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos inválidos

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

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 fluye).

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 que crea el conector, incluida una consulta indicada cuando fue la última vez que se recibió el tipo de datos en el área de trabajo.

Nombre	Tipo	Description
lastDataReceivedQuery	string	Obtiene o establece la consulta para indicar cuándo se recibieron los datos pertinentes por última vez en el área de trabajo.
name	string	Obtiene o establece el nombre del tipo de datos que se va a mostrar en el gráfico.

ConnectorDefinitionsAvailability

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	Estado de exposición del conector a los clientes. Los valores disponibles son 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal).

ConnectorDefinitionsPermissions

Permisos necesarios para el conector.

Nombre	Tipo	Description
customs	CustomPermissionDetails[]	Obtiene o establece los permisos aduaneros necesarios para que el usuario cree conexiones.
licenses	string[]	Obtiene o establece las licencias necesarias para que el usuario cree conexiones.
resourceProvider	ConnectorDefinitionsResourceProvider[]	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 (Read\Write, ..) 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 permisos.
provider	string	Obtiene o establece el nombre del proveedor.
providerDisplayName	string	Obtiene o establece el nombre para mostrar del proveedor de permisos.
requiredPermissions	ResourceProviderRequiredPermissions	Permisos necesarios para el proveedor de recursos del conector que se definen en ResourceProviders. Para obtener más información sobre los permisos, consulte aquí.
scope	ProviderPermissionsScope	Ámbito en el que el usuario debe tener permisos para poder crear conexiones.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomizableConnectionsConfig

UiConfig para el tipo de definición del conector "Personalizable".

Nombre	Tipo	Description
templateSpecName	string	Obtiene o establece el nombre de la plantilla. La plantilla incluye plantillas de ARM que el conector puede crear, normalmente serán las plantillas de ARM de dataConnectors.
templateSpecVersion	string	Obtiene o establece la versión de la plantilla.

CustomizableConnectorDefinition

Definición del conector para el tipo "Personalizable".

Nombre	Tipo	Description
etag	string	Etag del recurso de Azure
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string: Customizable	El tipo de conector de datos
name	string	Nombre del recurso.
properties.connectionsConfig	CustomizableConnectionsConfig	UiConfig para el tipo de definición del conector "Personalizable".
properties.connectorUiConfig	CustomizableConnectorUiConfig	UiConfig para el tipo de definición del conector "Personalizable".
properties.createdTimeUtc	string	Obtiene o establece la fecha de creación de la definición del conector en formato UTC.
properties.lastModifiedUtc	string	Obtiene o establece la fecha de la última modificación del conector en formato UTC.
systemData	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

UiConfig para el tipo de definición del conector "Personalizable".

Nombre	Tipo	Description
availability	ConnectorDefinitionsAvailability	Estado de exposición del conector a los clientes.
connectivityCriteria	ConnectivityCriterion[]	Obtiene o establece la forma en que el conector comprueba si el conector está conectado.
dataTypes	ConnectorDataType[]	Obtiene o establece los tipos de datos que se van a comprobar los últimos datos recibidos.
descriptionMarkdown	string	Obtiene o establece la descripción del conector en formato Markdown.
graphQueries	GraphQuery[]	Obtiene o establece las consultas del grafo para mostrar el volumen de datos actual a lo largo del tiempo.
id	string	Obtiene o establece el identificador del conector personalizado. Campo opcional.
instructionSteps	InstructionStep[]	Obtiene o establece los pasos de instrucción para habilitar el conector.
isConnectivityCriteriasMatchSome	boolean	Obtiene o establece un valor que indica si se va a usar "OR" (SOME) o "AND" entre los elementos ConnectivityCriteria.
logo	string	Obtiene o establece el logotipo del conector que se va a usar al mostrar el conector en la galería del conector de Azure Sentinel. El valor del logotipo debe estar en formato SVG.
permissions	ConnectorDefinitionsPermissions	Permisos necesarios para el conector.
publisher	string	Obtiene o establece el nombre del publicador del conector.
title	string	Obtiene o establece el título de la hoja del conector.

CustomPermissionDetails

Permisos personalizados necesarios para el conector.

Nombre	Tipo	Description
description	string	Obtiene o establece la descripción de permisos personalizados.
name	string	Obtiene o establece el nombre de los permisos personalizados.

DataConnectorDefinitionArmCollectionWrapper

Encapsular el objeto de definición del conector de datos

Nombre	Tipo	Description
nextLink	string
value	DataConnectorDefinition[]: CustomizableConnectorDefinition[]	Un recurso de Azure, que encapsula toda la información requiere que se muestre una página del conector de datos en Azure Portal y la información necesaria para definir conexiones de datos.

DataConnectorDefinitionKind

El tipo de definiciones del conector de datos

Nombre	Tipo	Description
Customizable	string

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 del 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 métrica que la consulta está comprobando. Por ejemplo: "Recepción total de datos".

InstructionStep

Pasos de instrucción para habilitar el conector.

Nombre	Tipo	Description
description	string	Obtiene o establece la descripción del paso de instrucción.
innerSteps	InstructionStep[]	Obtiene o establece los detalles de los pasos de instrucción internos. Ejemplo de foe: el paso de instrucción 1 podría contener pasos de instrucción internos: [paso de instrucción 1.1, paso de instrucción 1.2].
instructions	InstructionStepDetails[]	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 de la página del conector en El portal de Sentinel.

Nombre	Tipo	Description
parameters	object	Obtiene o establece la configuración de parámetros de tipo de instrucción.
type	string	Obtiene o establece el nombre del tipo de instrucción.

ProviderPermissionsScope

Ámbito en el que el usuario debe tener permisos para poder crear conexiones.

Nombre	Tipo	Description
ResourceGroup	string
Subscription	string
Workspace	string

ResourceProviderRequiredPermissions

Permisos necesarios para el proveedor de recursos del conector que se definen en ResourceProviders. Para obtener más información sobre los permisos, consulte aquí.

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 la acción de eliminación (DELETE).
read	boolean	Obtiene o establece un valor que indica si el permiso es 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 relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Share via