REST Resource: folders.locations.securityHealthAnalyticsCustomModules

Ressource: SecurityHealthAnalyticsCustomModule

Stellt eine Instanz eines benutzerdefinierten Security Health Analytics-Moduls dar, einschließlich des vollständigen Modulnamens, des Anzeigenamens, des Aktivierungsstatus und des Zeitpunkts der letzten Aktualisierung. Sie können ein benutzerdefiniertes Modul auf Organisations-, Ordner- oder Projektebene erstellen. Benutzerdefinierte Module, die Sie auf Organisations- oder Ordnerebene erstellen, werden von den untergeordneten Ordnern und Projekten übernommen.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "enablementState": enum (EnablementState),
  "updateTime": string,
  "lastEditor": string,
  "ancestorModule": string,
  "customConfig": {
    object (CustomConfig)
  }
}
Felder
name

string

Kennung. Der vollständige Ressourcenname des benutzerdefinierten Moduls in einem der folgenden Formate:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
displayName

string

Optional. Der Anzeigename des benutzerdefinierten Security Health Analytics-Moduls. Dieser Anzeigename wird zur Ergebniskategorie für alle Ergebnisse, die von diesem benutzerdefinierten Modul zurückgegeben werden. Der Anzeigename muss zwischen 1 und 128 Zeichen lang sein, mit einem Kleinbuchstaben beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten.
enablementState

enum (EnablementState)

Optional. Der Aktivierungsstatus des benutzerdefinierten Moduls.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das benutzerdefinierte Modul zuletzt aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
lastEditor

string

Nur Ausgabe. Der Editor, der das benutzerdefinierte Modul zuletzt aktualisiert hat.
ancestorModule

string

Nur Ausgabe. Gibt die Organisation oder den Ordner an, von dem das benutzerdefinierte Modul übernommen wird. Wenn das Feld leer ist, wurde das benutzerdefinierte Modul in der Organisation, dem Ordner oder dem Projekt erstellt, in dem Sie es gerade ansehen.
customConfig

object (CustomConfig)

Optional. Die vom Nutzer angegebene benutzerdefinierte Konfiguration für das Modul.

EnablementState

Mögliche Aktivierungsstatus eines benutzerdefinierten Moduls.

Enums
ENABLEMENT_STATE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
ENABLED Das Modul ist für die angegebene Organisation, den Ordner oder das Projekt aktiviert.
DISABLED Das Modul ist für die angegebene Organisation, den Ordner oder das Projekt deaktiviert.
INHERITED Der Status wird von einem übergeordneten Modul übernommen. Das Modul ist entweder ENABLED oder DISABLED, je nachdem, welches übergeordnete Modul in der Ressourcenhierarchie nicht vererbt wurde und am nächsten ist. Wenn Sie versuchen, ein Modul der obersten Ebene (ein Modul ohne übergeordnetes Element) in den Status INHERITED zu setzen, erhalten Sie einen INVALID_ARGUMENT-Fehler.

Methoden

create

 Erstellt eine lokale SecurityHealthAnalyticsCustomModule im Bereich der angegebenen Organisation, des angegebenen Ordners oder des angegebenen Projekts und auch übernommene SecurityHealthAnalyticsCustomModule-Ressourcen für alle Ordner und Projekte, die untergeordnet sind.

delete

 Löscht das angegebene SecurityHealthAnalyticsCustomModule und alle untergeordneten Elemente in der Ressourcenhierarchie.

get

 Ruft einen SecurityHealthAnalyticsCustomModule ab.

list

 Gibt eine Liste aller SecurityHealthAnalyticsCustomModule-Ressourcen für das übergeordnete Element zurück.

listDescendant

 Gibt eine Liste aller SecurityHealthAnalyticsCustomModule-Ressourcen in der angegebenen Organisation, dem angegebenen Ordner oder dem angegebenen Projekt und allen untergeordneten Elementen zurück.

patch

 Aktualisiert die SecurityHealthAnalyticsCustomModule unter dem angegebenen Namen anhand der angegebenen Aktualisierungsmaske.

simulate

 Simuliert das Ergebnis der Verwendung eines SecurityHealthAnalyticsCustomModule zum Prüfen einer Ressource.