Referência do conector de dados GCP para o Codeless Connector Framework

Para criar um conector de dados do Google Cloud Platform (GCP) com o Codeless Connector Framework (CCF), utilize esta referência como um suplemento para os documentos Microsoft Sentinel API REST para Conectores de Dados.

Cada dataConnector um representa uma ligação específica de um conector de dados Microsoft Sentinel. Um conector de dados pode ter várias ligações, que obtêm dados de diferentes pontos finais. A configuração JSON criada com este documento de referência é utilizada para concluir o modelo de implementação do conector de dados CCF.

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

Criar o conector de dados CCF do GCP

Simplifique o desenvolvimento da ligação da origem de dados GCP com um modelo de implementação de conector de dados CCF de exemplo.

Modelo de exemplo CCF do GCP

Com a maioria das secções do modelo de implementação preenchidas, só precisa de criar os dois primeiros componentes, a tabela de saída e o DCR. Para obter mais informações, veja as secções Definição da tabela de saída e Regra de Recolha de Dados (DCR).

Conectores de Dados – Criar ou atualizar

Veja a operação Criar ou Atualizar nos documentos da API REST para encontrar a versão mais recente da API estável ou de pré-visualização. A diferença entre a operação de criação e atualização é que a atualização requer o valor de 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, veja Conectores de Dados – Criar ou Atualizar Parâmetros de URI.

Nome	Descrição
dataConnectorId	O ID do conector de dados tem de ser um nome exclusivo e é o mesmo que o name parâmetro no corpo do pedido.
resourceGroupName	O nome do grupo de recursos, não sensível a maiúsculas e minúsculas.
subscriptionId	O ID da subscrição de destino.
workspaceName	O nome da área de trabalho, não o ID. Padrão Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
versão da API	A versão da API a utilizar para esta operação.

Corpo da solicitação

O corpo do pedido para um GCP conector de dados CCF tem a seguinte estrutura:

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

GCP

O GCP representa um conector de dados CCF onde já foram configurados os payloads de paginação e resposta esperados para a sua origem de dados do Google Cloud Platform (GCP). A configuração do serviço GCP para enviar dados para um GCP Pub/Sub tem de ser feita separadamente. Para obter mais informações, consulte Publish message in Pub/Sub overview (Descrição geral de Publicar mensagem em Pub/Sub).

Nome	Obrigatório	Tipo	Descrição
name	True	string	O nome exclusivo da ligação que corresponde ao parâmetro URI
kind	True	string	Deve ser GCP
etag		GUID	Deixe vazio para a criação de novos conectores. Para operações de atualização, a etag tem de corresponder à etag (GUID) do conector existente.
properties.connectorDefinitionName		string	O nome do recurso DataConnectorDefinition que define a configuração da IU do conector de dados. Para obter mais informações, veja Definição do Conector de Dados.
propriedades. autenticação	Verdadeiro	JSON Aninhado	Descreve as credenciais para consultar os dados do GCP. Para obter mais informações, veja Configuração da autenticação.
propriedades. pedido	Verdadeiro	JSON Aninhado	Descreve o ID do projeto GCP e a subscrição do GCP para consultar os dados. Para obter mais informações, veja Configuração do pedido.
propriedades. dcrConfig		JSON Aninhado	Parâmetros necessários quando os dados são enviados para uma Regra de Recolha de Dados (DCR). Para obter mais informações, veja Configuração do DCR.

Configuração da autenticação

A autenticação no GCP a partir de Microsoft Sentinel utiliza um GcP Pub/Sub. Tem de configurar a autenticação separadamente. Utilize os scripts do Terraform aqui. Para obter mais informações, veja GcP Pub/Sub authentication from another cloud provider (Autenticação GCP Pub/Sub a partir de outro fornecedor de cloud).

Como melhor prática, utilize parâmetros na secção de autenticação em vez de credenciais de hard-coding. Para obter mais informações, veja Proteger entradas confidenciais.

Para criar o modelo de implementação que também utiliza parâmetros, tem de escapar aos parâmetros nesta secção com um início [adicional. Isto permite que os parâmetros atribuam um valor com base na interação do utilizador com o conector. Para obter mais informações, veja Carateres de escape de expressões de modelo.

Para permitir que as credenciais sejam introduzidas a partir da IU, a connectorUIConfig secção requer instructions os parâmetros pretendidos. Para obter mais informações, veja Referência de definições do conector de dados para o Codeless Connector Framework.

Exemplo de autenticação GCP:

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

Configuração do pedido

A secção do pedido requer o projectId e subscriptionNames do GCP Pub/Sub.

Exemplo de pedido GCP:

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

Configuração do DCR

Campo	Obrigatório	Tipo	Descrição
DataCollectionEndpoint	Verdadeiro	Cadeia de caracteres	DCE (Ponto Final de Recolha de Dados), por exemplo: https://example.ingest.monitor.azure.com.
DataCollectionRuleImmutableId	Verdadeiro	Cadeia de caracteres	O ID imutável do DCR. Localize-a visualizando a resposta de criação do DCR ou utilizando a API DCR
StreamName	True	string	Este valor é o streamDeclaration definido no DCR (o prefixo tem de começar por Personalizado-)

Conector de dados CCF de exemplo

Eis um exemplo de todos os componentes do JSON do GCP conector de dados CCF em conjunto.

{
    "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, veja Create GCP data connector REST API example (Exemplo de API REST do conector de dados GCP).