Referencia del conector de datos GCP para Codeless Connector Framework

Para crear un conector de datos de Google Cloud Platform (GCP) con Codeless Connector Framework (CCF), use esta referencia como complemento a la Microsoft Sentinel documentación de la API REST para conectores de datos.

Cada uno dataConnector representa una conexión específica de un conector de datos de Microsoft Sentinel. Un conector de datos puede tener varias conexiones, que capturan datos de distintos puntos de conexión. La configuración JSON compilada con este documento de referencia se usa para completar la plantilla de implementación para el conector de datos CCF.

Para obtener más información, consulte Creación de un conector sin código para Microsoft Sentinel.

Compilación del conector de datos CCF de GCP

Simplifique el desarrollo de la conexión del origen de datos GCP con una plantilla de implementación de conector de datos CCF de GCP de ejemplo.

Plantilla de ejemplo de GCP CCF

Con la mayoría de las secciones de plantilla de implementación rellenadas, solo es necesario compilar los dos primeros componentes, la tabla de salida y la DCR. Para obtener más información, vea las secciones Definición de tabla de salida y Regla de recopilación de datos (DCR).

Conectores de datos: creación o actualización

Haga referencia a la operación crear o actualizar en los documentos de la API REST para encontrar la versión más reciente de la API estable o en versión preliminar. La diferencia entre la operación de creación y actualización es que la actualización requiere el valor etag .

Método PUT

https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.OperationalInsights/workspaces/{{workspaceName}}/providers/Microsoft.SecurityInsights/dataConnectors/{{dataConnectorId}}?api-version={{apiVersion}}

Parámetros de URI

Para obtener más información sobre la versión más reciente de la API, consulte Conectores de datos: creación o actualización de parámetros de URI.

Nombre	Descripción
dataConnectorId	El identificador del conector de datos debe ser un nombre único y es el mismo que el name parámetro en el cuerpo de la solicitud.
resourceGroupName	Nombre del grupo de recursos, no distingue mayúsculas de minúsculas.
subscriptionId	Identificador de la suscripción de destino.
workspaceName	El nombre del área de trabajo, no el identificador. Patrón Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	Versión de API que se va a usar para esta operación.

Cuerpo de la solicitud

El cuerpo de la solicitud para un GCP conector de datos CCF tiene la siguiente estructura:

{
   "name": "{{dataConnectorId}}",
   "kind": "GCP",
   "etag": "",
   "properties": {
        "connectorDefinitionName": "",
        "auth": {},
        "request": {},
        "dcrConfig": ""
   }
}

GCP

GCP representa un conector de datos CCF donde ya se han configurado las cargas de paginación y respuesta esperadas para el origen de datos de Google Cloud Platform (GCP). La configuración del servicio GCP para enviar datos a un GCP Pub/Sub debe realizarse por separado. Para obtener más información, consulte Publicación de mensajes en Información general de Pub/Sub.

Nombre	Obligatorio	Tipo	Descripción
name	True	string	Nombre único de la conexión que coincide con el parámetro URI
kind	True	string	Debe ser GCP
etag		GUID	Deje vacío para la creación de nuevos conectores. Para las operaciones de actualización, el etag debe coincidir con el etag (GUID) del conector existente.
properties.connectorDefinitionName		string	Nombre del recurso DataConnectorDefinition que define la configuración de la interfaz de usuario del conector de datos. Para obtener más información, vea Definición del conector de datos.
propiedades. autenticación	Verdadero	JSON anidado	Describe las credenciales para sondear los datos de GCP. Para obtener más información, consulte configuración de autenticación.
propiedades. solicitud	Verdadero	JSON anidado	Describe el identificador del proyecto GCP y la suscripción de GCP para sondear los datos. Para obtener más información, consulte configuración de solicitudes.
propiedades. dcrConfig		JSON anidado	Parámetros necesarios cuando los datos se envían a una regla de recopilación de datos (DCR). Para obtener más información, consulte Configuración de DCR.

Configuración de autenticación

La autenticación en GCP desde Microsoft Sentinel usa un GCP Pub/Sub. Debe configurar la autenticación por separado. Use los scripts de Terraform aquí. Para obtener más información, consulte Autenticación de GCP Pub/Sub desde otro proveedor de nube.

Como procedimiento recomendado, use parámetros en la sección de autenticación en lugar de las credenciales de codificación rígida. Para obtener más información, consulte Protección de la entrada confidencial.

Para crear la plantilla de implementación que también usa parámetros, debe escapar los parámetros de esta sección con un inicio [adicional. Esto permite a los parámetros asignar un valor en función de la interacción del usuario con el conector. Para obtener más información, vea Caracteres de escape de expresiones de plantilla.

Para permitir que las credenciales se escriban desde la interfaz de usuario, la connectorUIConfig sección requiere instructions con los parámetros deseados. Para obtener más información, vea Referencia de definiciones de conector de datos para Codeless Connector Framework.

Ejemplo de autenticación de GCP:

"auth": {
    "serviceAccountEmail": "[[parameters('GCPServiceAccountEmail')]",
    "projectNumber": "[[parameters('GCPProjectNumber')]",
    "workloadIdentityProviderId": "[[parameters('GCPWorkloadIdentityProviderId')]"
}

Configuración de la solicitud

La sección de solicitud requiere y projectIdsubscriptionNames de GCP Pub/Sub.

Ejemplo de solicitud de GCP:

"request": {
    "projectId": "[[parameters('GCPProjectId')]",
    "subscriptionNames": [
        "[[parameters('GCPSubscriptionName')]"
    ]
}

Configuración de DCR

Campo	Obligatorio	Tipo	Description
DataCollectionEndpoint	Verdadero	Cadena	DCE (punto de conexión de recopilación de datos) por ejemplo: https://example.ingest.monitor.azure.com.
DataCollectionRuleImmutableId	Verdadero	Cadena	Identificador inmutable de DCR. Para encontrarlo, consulte la respuesta de creación de DCR o use la API de DCR.
StreamName	True	string	Este valor es el streamDeclaration definido en dcr (el prefijo debe comenzar por Custom-)

Conector de datos CCF de ejemplo

Este es un ejemplo de todos los componentes del GCP json del conector de datos CCF juntos.

{
    "kind": "GCP",
    "properties": {
        "connectorDefinitionName": "[[parameters('connectorDefinitionName')]",
        "dcrConfig": {
            "streamName": "[variables('streamName')]",
            "dataCollectionEndpoint": "[[parameters('dcrConfig').dataCollectionEndpoint]",
            "dataCollectionRuleImmutableId": "[[parameters('dcrConfig').dataCollectionRuleImmutableId]"
        },
    "dataType": "[variables('dataType')]",
    "auth": {
        "serviceAccountEmail": "[[parameters('GCPServiceAccountEmail')]",
        "projectNumber": "[[parameters('GCPProjectNumber')]",
        "workloadIdentityProviderId": "[[parameters('GCPWorkloadIdentityProviderId')]"
    },
    "request": {
        "projectId": "[[parameters('GCPProjectId')]",
        "subscriptionNames": [
            "[[parameters('GCPSubscriptionName')]"
            ]
        }
    }
}

Para obtener más información, consulte El ejemplo de API REST del conector de datos GCP.