Dokumentacja łącznika danych GCP dla platformy łącznika bez kodu

Artykuł
10/02/2024

Aby utworzyć łącznik danych platformy Google Cloud Platform (GCP) z platformą łącznika bez użycia kodu (SOAP), użyj tego odwołania jako dodatku do dokumentacji interfejsu API REST usługi Microsoft Sentinel dla łączników danych.

Każdy dataConnector reprezentuje określone połączenie łącznika danych usługi Microsoft Sentinel. Jeden łącznik danych może mieć wiele połączeń, które pobierają dane z różnych punktów końcowych. Konfiguracja JSON utworzona przy użyciu tego dokumentu referencyjnego służy do ukończenia szablonu wdrożenia dla łącznika danych INTERFEJSu API.

Aby uzyskać więcej informacji, zobacz Tworzenie łącznika bez kodu dla usługi Microsoft Sentinel.

Tworzenie łącznika danych GCP SOAP

Uproszczenie opracowywania źródła danych GCP za pomocą przykładowego szablonu wdrażania łącznika danych GCP KPPC.

Przykładowy szablon GCP KPI

Po wypełnieniu większości sekcji szablonu wdrożenia wystarczy utworzyć tylko dwa pierwsze składniki, tabelę wyjściową i kontroler domeny. Aby uzyskać więcej informacji, zobacz sekcje Definicja tabeli danych i Reguła zbierania danych (DCR).

Łączniki danych — tworzenie lub aktualizowanie

Zapoznaj się z dokumentacją tworzenia lub aktualizowania w dokumentacji interfejsu API REST, aby znaleźć najnowszą stabilną lub zapoznawczą wersję interfejsu API. Różnica między operacją tworzenia i aktualizacji polega na tym, że aktualizacja wymaga wartości elementu etag .

PUT , metoda

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

Parametry identyfikatora URI

Aby uzyskać więcej informacji na temat najnowszej wersji interfejsu API, zobacz Łączniki danych — tworzenie lub aktualizowanie parametrów identyfikatora URI.

Nazwa/nazwisko	opis
dataConnectorId	Identyfikator łącznika danych musi być unikatową nazwą i jest taki sam jak `name` parametr w treści żądania.
resourceGroupName	Nazwa grupy zasobów, a nie uwzględnia wielkości liter.
subscriptionId	Identyfikator subskrypcji docelowej.
workspaceName	Nazwa obszaru roboczego, a nie identyfikator. Wzorzec wyrażenia regularnego: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
wersja interfejsu API	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Treść żądania dla łącznika GCP danych PROTOKOŁU KPCH ma następującą strukturę:

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

GCP

GCP reprezentuje łącznik danych PROTOKOŁU TRANSLATOR, w którym skonfigurowano już stronicowanie i oczekiwane ładunki odpowiedzi dla źródła danych platformy Google Cloud Platform (GCP). Skonfigurowanie usługi GCP w celu wysyłania danych do usługi GCP Pub/Sub musi odbywać się oddzielnie. Aby uzyskać więcej informacji, zobacz Publikowanie komunikatu w pubie/pod omówieniem.

Nazwisko	Wymagania	Type	opis
name	Prawda	string	Unikatowa nazwa połączenia zgodnego z parametrem identyfikatora URI
rodzaj	Prawda	string	Musi być `GCP`
etag		Identyfikator GUID	Pozostaw wartość pustą do utworzenia nowych łączników. W przypadku operacji aktualizacji element etag musi być zgodny z identyfikatorem etag istniejącego łącznika (GUID).
properties.connectorDefinitionName		string	Nazwa zasobu DataConnectorDefinition definiującego konfigurację interfejsu użytkownika łącznika danych. Aby uzyskać więcej informacji, zobacz Definicja łącznika danych.
Właściwości.Auth	Prawda	Zagnieżdżony kod JSON	Opisuje poświadczenia sondowania danych GCP. Aby uzyskać więcej informacji, zobacz Konfiguracja uwierzytelniania.
Właściwości.prosić	Prawda	Zagnieżdżony kod JSON	Opisuje identyfikator projektu GCP i subskrypcję GCP na potrzeby sondowania danych. Aby uzyskać więcej informacji, zobacz konfiguracja żądania.
Właściwości.dcrConfig		Zagnieżdżony kod JSON	Wymagane parametry, gdy dane są wysyłane do reguły zbierania danych (DCR). Aby uzyskać więcej informacji, zobacz Konfiguracja kontrolera domeny.

Konfiguracja uwierzytelniania

Uwierzytelnianie na platformie GCP z usługi Microsoft Sentinel używa pubu GCP/sub. Należy oddzielnie skonfigurować uwierzytelnianie. W tym miejscu użyj skryptów programu Terraform. Aby uzyskać więcej informacji, zobacz GCP Pub/Sub authentication from another cloud provider (Uwierzytelnianie GCP Pub/Sub od innego dostawcy usług w chmurze).

Najlepszym rozwiązaniem jest użycie parametrów w sekcji uwierzytelniania zamiast poświadczeń kodowania na stałe. Aby uzyskać więcej informacji, zobacz Zabezpieczanie poufnych danych wejściowych.

Aby utworzyć szablon wdrożenia, który używa również parametrów, należy poznać parametry w tej sekcji z dodatkowym początkowym elementem [. Dzięki temu parametry mogą przypisywać wartość na podstawie interakcji użytkownika z łącznikiem. Aby uzyskać więcej informacji, zobacz Znaki ucieczki wyrażeń szablonu.

Aby umożliwić podanie poświadczeń z interfejsu użytkownika, connectorUIConfig sekcja wymaga instructions odpowiednich parametrów. Aby uzyskać więcej informacji, zobacz Dokumentacja definicji łącznika danych dla platformy łącznika bez kodu.

Przykład uwierzytelniania GCP:

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

Konfiguracja żądania

Sekcja żądania wymaga parametru projectId i subscriptionNames z usługi GCP Pub/Sub.

Przykład żądania GCP:

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

Konfiguracja kontrolera domeny

Pole	Wymagania	Type	Opis
DataCollectionEndpoint	Prawda	String	DCE (punkt końcowy zbierania danych) na przykład: `https://example.ingest.monitor.azure.com`.
DataCollectionRuleImmutableId	Prawda	String	Niezmienny identyfikator DCR. Znajdź go, wyświetlając odpowiedź tworzenia kontrolera domeny lub używając interfejsu API DCR
StreamName	Prawda	string	Ta wartość jest zdefiniowana `streamDeclaration` w kontrolerze domeny (prefiks musi zaczynać się od custom-)

Przykładowy łącznik danych PROTOKOŁU KPS

Poniżej przedstawiono przykład wszystkich składników formatu JSON łącznika GCP danych ORGANIZACJI.

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

Aby uzyskać więcej informacji, zobacz Tworzenie przykładu interfejsu API REST łącznika danych GCP.

Udostępnij za pośrednictwem