GCP-Datenkonnektorreferenz für die Codeless Connector Platform

Artikel
10/01/2024

Um einen Google Cloud Platform (GCP)-Datenkonnektor mit der Codeless Connector Platform (CCP) zu erstellen, verwenden Sie diese Referenz als Ergänzung zur Microsoft Sentinel-REST-API für Datenconnectors-Dokumente .

Jede dataConnector stellt eine bestimmte Verbindung eines Microsoft Sentinel-Datenconnectors dar. Ein Datenconnector verfügt möglicherweise über mehrere Verbindungen, die Daten aus verschiedenen Endpunkten abrufen. Die JSON-Konfiguration, die mit diesem Referenzdokument erstellt wurde, wird verwendet, um die Bereitstellungsvorlage für den CCP-Datenconnector abzuschließen.

Weitere Informationen finden Sie unter Erstellen eines codelosen Connectors für Microsoft Sentinel.

Erstellen des GCP CCP-Datenconnectors

Vereinfachen Sie die Entwicklung der Verbindung Ihrer GCP-Datenquelle mit einer Beispielvorlage für die Bereitstellung von GCP CCP-Datenkonnektoren.

GCP CCP-Beispielvorlage

Wenn die meisten Bereitstellungsvorlagenabschnitte ausgefüllt sind, müssen Sie nur die ersten beiden Komponenten erstellen, die Ausgabetabelle und die DCR. Weitere Informationen finden Sie in den Abschnitten "Output table definition " und "Data Collection Rule(DCR) ".

Datenconnectors – Erstellen oder Aktualisieren

Verweisen Sie auf den Erstellungs- oder Aktualisierungsvorgang in den REST-API-Dokumenten, um die neueste stabile oder Vorschau-API-Version zu finden. Der Unterschied zwischen dem Erstellungs - und dem Aktualisierungsvorgang ist die Aktualisierung, die den etag-Wert erfordert.

PUT-Methode

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

URI-Parameter

Weitere Informationen zur neuesten API-Version finden Sie unter Data Connectors – Create or Update URI Parameters.

Name	Beschreibung
dataConnectorId	Die Datenconnector-ID muss ein eindeutiger Name sein und ist identisch mit dem `name` Parameter im Anforderungstext.
resourceGroupName	Der Name der Ressourcengruppe, nicht die Groß-/Kleinschreibung.
subscriptionId	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	Der Name des Arbeitsbereichs, nicht die ID. RegEx-Muster: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Der Anforderungstext für einen GCP CCP-Datenkonnektor hat die folgende Struktur:

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

GCP

GCP stellt einen CCP-Datenkonnektor dar, bei dem die Paging- und erwarteten Antwortnutzlasten für Ihre Google Cloud Platform (GCP)-Datenquelle bereits konfiguriert wurden. Das Konfigurieren Ihres GCP-Diensts zum Senden von Daten an eine GCP Pub/Sub muss separat erfolgen. Weitere Informationen finden Sie unter Veröffentlichen der Nachricht in pub/Sub (Übersicht).

Name	Erforderlich	Type	BESCHREIBUNG
name	True	Zeichenfolge	Der eindeutige Name der Verbindung, die mit dem URI-Parameter übereinstimmen
kind	True	Zeichenfolge	Muss gleich `GCP` sein.
etag		GUID	Lassen Sie leer, um neue Connectors zu erstellen. Bei Aktualisierungsvorgängen muss das Etag mit dem Etag (GUID) des vorhandenen Connectors übereinstimmen.
properties.connectorDefinitionName		Zeichenfolge	Der Name der DataConnectorDefinition-Ressource, die die UI-Konfiguration des Datenconnectors definiert. Weitere Informationen finden Sie unter Data Connector Definition.
Eigenschaften.Auth	True	Geschachteltes JSON	Beschreibt die Anmeldeinformationen zum Abrufen der GCP-Daten. Weitere Informationen finden Sie unter Authentifizierungskonfiguration.
Eigenschaften.bitten	True	Geschachteltes JSON	Beschreibt die GCP-Projekt-ID und das GCP-Abonnement zum Abrufen der Daten. Weitere Informationen finden Sie unter Anforderungskonfiguration.
Eigenschaften.dcrConfig		Geschachteltes JSON	Erforderliche Parameter, wenn die Daten an eine Datensammlungsregel (Data Collection Rule, DCR) gesendet werden. Weitere Informationen finden Sie unter DCR-Konfiguration.

Authentifizierungskonfiguration

Die Authentifizierung bei GCP von Microsoft Sentinel verwendet einen GCP Pub/Sub. Sie müssen die Authentifizierung separat konfigurieren. Verwenden Sie hier die Terraform-Skripts. Weitere Informationen finden Sie unter GCP Pub/Sub Authentication von einem anderen Cloudanbieter.

Verwenden Sie als bewährte Methode Parameter im Authentifizierungsabschnitt anstelle von hartcodierenden Anmeldeinformationen. Weitere Informationen finden Sie unter Sichere vertrauliche Eingaben.

Um die Bereitstellungsvorlage zu erstellen, die auch Parameter verwendet, müssen Sie die Parameter in diesem Abschnitt mit einem zusätzlichen Start [escapeen. Dadurch können die Parameter einen Wert zuweisen, der auf der Interaktion des Benutzers mit dem Konnektor beruht. Weitere Informationen finden Sie unter Escapezeichen für Vorlagenausdrücke.

Damit die Anmeldeinformationen über die Benutzeroberfläche eingegeben werden können, benötigt instructions der connectorUIConfig Abschnitt die gewünschten Parameter. Weitere Informationen finden Sie in der Datenkonnektordefinitionsreferenz für die Codeless Connector Platform.

Beispiel für GCP-Authentifizierung:

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

Anforderungskonfiguration

Der Anforderungsabschnitt erfordert und projectId subscriptionNames von der GCP Pub/Sub.

Beispiel für GCP-Anforderung:

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

DCR-Konfiguration

Feld	Erforderlich	Type	Beschreibung
DataCollectionEndpoint	True	String	DCE (Data Collection Endpoint) for example: `https://example.ingest.monitor.azure.com`.
DataCollectionRuleImmutableId	True	String	Die unveränderliche DCR-ID. Suchen Sie sie, indem Sie die DCR-Erstellungsantwort anzeigen oder die DCR-API verwenden.
StreamName	True	Zeichenfolge	Dieser Wert ist der `streamDeclaration` im DCR definierte Wert (Präfix muss mit "Benutzerdefiniert") beginnen.

Beispiel für CCP-Datenkonnektor

Hier ist ein Beispiel für alle Komponenten des GCP CCP-Datenconnectors JSON zusammen.

{
    "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')]"
            ]
        }
    }
}

Weitere Informationen finden Sie im Beispiel zum Erstellen von GCP-Datenkonnektor-REST-API.

Freigeben über