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

Artigo
10/01/2024

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

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 pontos de extremidade diferentes. A configuração JSON criada usando este documento de referência é usada para concluir o modelo de implantação para o conector de dados CCP.

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

Criar o conector de dados CCP do GCP

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

Modelo de exemplo de CCP GCP

Com a maioria das seções de 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 estável ou de visualização mais recente da API. A diferença entre a operação de criação e a operação de 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 de 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	O 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, não diferencia maiúsculas de minúsculas.
subscriptionId	A ID da assinatura de destino.
nome do espaço de trabalho	O nome do espaço de trabalho, não a ID. Padrão Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
API-versão	A versão da API a utilizar para esta operação.

Corpo do pedido

O corpo do pedido de 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 onde a paginação e as cargas úteis de resposta esperadas para sua fonte de dados do Google Cloud Platform (GCP) já foram configuradas. A configuração do serviço GCP para enviar dados para um Pub/Sub GCP deve ser feita separadamente. Para obter mais informações, consulte Visão geral de Publicar mensagem em Pub/Sub.

Nome	Obrigatório	Type	Description
Designação	True	string	O nome exclusivo da conexão correspondente ao parâmetro URI
tipo	True	string	Deve ser `GCP`
etag		GUID	Deixe em branco para a criação de novos conectores. Para operações de atualização, o etag deve corresponder ao 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	True	JSON aninhado	Descreve as credenciais para sondar os dados do GCP. Para obter mais informações, consulte Configuração de autenticação.
propriedades.solicitar	True	JSON aninhado	Descreve a ID do projeto GCP e a assinatura do GCP para sondar os dados. Para obter mais informações, consulte Configuração de solicitação.
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 para GCP do Microsoft Sentinel usa um GCP Pub/Sub. Você deve configurar a autenticação separadamente. Use os scripts Terraform aqui. Para obter mais informações, consulte Autenticação GCP Pub/Sub de outro provedor de nuvem.

Como prática recomendada, use parâmetros na seção de autenticação em vez de credenciais de codificação. Para obter mais informações, consulte Proteger 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 início [extra. 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 a partir da 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 Codeless Connector.

Exemplo de autenticação GCP:

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

Solicitar configuração

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

Exemplo de solicitação GCP:

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

Configuração DCR

Campo	Necessário	Type	Description
DataCollectionEndpoint	True	String	DCE (Data Collection Endpoint), por exemplo: `https://example.ingest.monitor.azure.com`.
DataCollectionRuleImmutableId	True	String	O ID IMUTÁVEL DCR. Encontre-o visualizando a resposta de criação do DCR ou usando a API do DCR
Nome do fluxo	True	string	Este valor é o definido no DCR (prefixo `streamDeclaration` deve começar com Custom-)

Exemplo de conector de dados CCP

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

Partilhar via