Referência do conector de dados do GCP para a plataforma Codeless Connector

Artigo
10/01/2024

Para criar um conector de dados do Google Cloud Platform (GCP) com a Codeless Connector Platform (CCP), use essa referência como um complemento aos documentos da API REST do Microsoft Sentinel para Data Connectors .

Cada dataConnector um representa uma conexão específica de um conector de dados do Microsoft Sentinel. Um conector de dados pode ter várias conexões, que buscam dados de diferentes pontos de extremidade. A configuração JSON criada usando este documento de referência é usada para concluir o modelo de implantação do conector de dados CCP.

Para obter mais informações, confira Criar um conector sem código para o Microsoft Sentinel.

Criar o conector de dados do GCP CCP

Simplifique o desenvolvimento da conexão da fonte de dados do GCP com um modelo de implantação de conector de dados do GCP CCP de amostra.

Modelo de exemplo de CCP do GCP

Com a maioria das seções do modelo de implantação preenchidas, você só precisa criar os dois primeiros componentes, a tabela de saída e o DCR. Para obter mais informações, consulte as seções Definição da tabela de saída e Regra de coleta de dados (DCR).

Conectores de dados - Criar ou atualizar

Consulte a operação Criar ou Atualizar nos documentos da API REST para encontrar a versão mais recente da API estável ou de visualização. A diferença entre a operação de criação e atualização é que a atualização requer o 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 do URI

Para obter mais informações sobre a versão mais recente da API, consulte Conectores de dados – Criar ou atualizar parâmetros de URI.

Nome	Descrição
dataConnectorId	A ID do conector de dados deve ser um nome exclusivo e é o mesmo que o `name` parâmetro no corpo da solicitação.
resourceGroupName	O nome do grupo de recursos, sem distinção entre maiúsculas e minúsculas.
subscriptionId	A ID da assinatura de destino.
workspaceName	O nome do workspace, não a ID. Padrão Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	A versão da API a ser usada para esta operação.

Corpo da solicitação

O corpo da solicitação para um GCP conector de dados CCP tem a seguinte estrutura:

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

GCP

O GCP representa um conector de dados CCP em que a paginação e os payloads de resposta esperados para sua fonte de dados do Google Cloud Platform (GCP) já foram configurados. A configuração do serviço do GCP para enviar dados para um Pub/Sub do GCP precisa ser feita separadamente. Para obter mais informações, consulte Publicar mensagem na visão geral do Pub/Sub.

Nome	Obrigatória	Type	Descrição
name	True	string	O nome exclusivo da conexão correspondente ao parâmetro URI
kind	True	string	Precisa ser `GCP`
etag		GUID	Deixe vazio para a criação de novos conectores. Para operações de atualização, a etag deve corresponder à etag (GUID) do conector existente.
properties.connectorDefinitionName		string	O nome do recurso DataConnectorDefinition que define a configuração da interface do usuário do conector de dados. Para obter mais informações, consulte Definição do conector de dados.
Propriedades.Auth	Verdadeiro	JSON aninhado	Descreve as credenciais para sondar os dados do GCP. Para obter mais informações, consulte configuração de autenticação.
Propriedades.pedir	Verdadeiro	JSON aninhado	Descreve o ID do projeto do GCP e a assinatura do GCP para sondar os dados. Para mais informações, confira configuração de request.
Propriedades.dcrConfig		JSON aninhado	Parâmetros necessários quando os dados são enviados para uma Regra de Coleta de Dados (DCR). Para obter mais informações, consulte Configuração do DCR.

Configuração de autenticação

A autenticação do Microsoft Sentinel no GCP usa um GCP Pub/Sub. Você deve configurar a autenticação separadamente. Use os scripts do Terraform aqui. Para mais informações, consulte Autenticação do GCP Pub/Sub de outro provedor de nuvem.

Como prática recomendada, use parâmetros na seção auth em vez de credenciais codificadas. Para obter mais informações, consulte Proteger a entrada confidencial.

Para criar o modelo de implantação que também usa parâmetros, você precisa escapar dos parâmetros nesta seção com um .[ Isso permite que os parâmetros atribuam um valor com base na interação do usuário com o conector. Para obter mais informações, consulte Caracteres de escape de expressões de modelo.

Para permitir que as credenciais sejam inseridas na interface do usuário, a connectorUIConfig seção requer instructions os parâmetros desejados. Para obter mais informações, consulte Referência de definições de conector de dados para a Plataforma de Conector Sem Código.

Exemplo de autenticação do GCP:

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

Configuração de solicitação

A seção de solicitação requer o projectId e subscriptionNames do GCP Pub/Sub.

Exemplo de solicitação do GCP:

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

Configuração DCR

Campo	Obrigatório	Type	Descrição
DataCollectionEndpoint	True	String	DCE (Data Collection Endpoint), por exemplo: `https://example.ingest.monitor.azure.com`.
DataCollectionRuleImmutableId	True	String	A ID imutável do DCR. Encontre-o exibindo a resposta de criação do DCR ou usando a API do DCR
StreamName	True	string	Esse valor é definido `streamDeclaration` no DCR (o prefixo deve começar com Custom-)

Exemplo de conector de dados CCP

Aqui está um exemplo de todos os componentes do GCP JSON do conector de dados CCP 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 mais informações, consulte Exemplo de criação da API REST do conector de dados do GCP.

Compartilhar via