REST Resource: folders.locations.securityHealthAnalyticsCustomModules

Ressource: SecurityHealthAnalyticsCustomModule

Représente une instance d'un module personnalisé Security Health Analytics, y compris son nom complet, son nom à afficher, son état d'activation et l'heure de la dernière modification. Vous pouvez créer un module personnalisé au niveau de l'organisation, du dossier ou du projet. Les modules personnalisés que vous créez au niveau de l'organisation ou du dossier sont hérités par les dossiers et les projets descendants.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "enablementState": enum (EnablementState),
  "updateTime": string,
  "lastEditor": string,
  "ancestorModule": string,
  "customConfig": {
    object (CustomConfig)
  }
}
Champs
name

string

Identifiant. Nom de ressource complet du module personnalisé, dans l'un des formats suivants:

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

string

Facultatif. Nom à afficher du module personnalisé Security Health Analytics. Ce nom à afficher devient la catégorie de résultats pour tous les résultats renvoyés par ce module personnalisé. Le nom à afficher doit comporter entre 1 et 128 caractères, commencer par une lettre minuscule et ne contenir que des caractères alphanumériques et des traits de soulignement.
enablementState

enum (EnablementState)

Facultatif. État d'activation du module personnalisé.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour du module personnalisé.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
lastEditor

string

Uniquement en sortie. Éditeur qui a mis à jour le module personnalisé pour la dernière fois.
ancestorModule

string

Uniquement en sortie. Spécifie l'organisation ou le dossier à partir duquel le module personnalisé est hérité. Si ce champ est vide, cela signifie que le module personnalisé a été créé dans l'organisation, le dossier ou le projet dans lequel vous le consultez.
customConfig

object (CustomConfig)

Facultatif. Configuration personnalisée spécifiée par l'utilisateur pour le module.

EnablementState

États d'activation possibles d'un module personnalisé.

Enums
ENABLEMENT_STATE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
ENABLED Le module est activé au niveau de l'organisation, du dossier ou du projet donnés.
DISABLED Le module est désactivé au niveau de l'organisation, du dossier ou du projet donnés.
INHERITED L'état est hérité d'un module parent. Le module sera effectivement ENABLED ou DISABLED en fonction de son module ancestral non hérité le plus proche dans la hiérarchie des ressources. Si vous essayez de définir un module racine (un module sans parent) sur l'état INHERITED, une erreur INVALID_ARGUMENT s'affiche.

Méthodes

create

 Crée un SecurityHealthAnalyticsCustomModule résident dans le champ d'application de l'organisation, du dossier ou du projet donnés, et crée également des ressources SecurityHealthAnalyticsCustomModule héritées pour tous les dossiers et projets qui sont des descendants du parent donné.

delete

 Supprime l'SecurityHealthAnalyticsCustomModule spécifié et tous ses descendants dans la hiérarchie des ressources.

get

 Récupère un SecurityHealthAnalyticsCustomModule.

list

 Renvoie la liste de toutes les ressources SecurityHealthAnalyticsCustomModule pour le parent donné.

listDescendant

 Affiche la liste de toutes les ressources SecurityHealthAnalyticsCustomModule résidentes de l'organisation, du dossier ou du projet donné, ainsi que de tous ses descendants.

patch

 Met à jour le SecurityHealthAnalyticsCustomModule sous le nom donné en fonction du masque de mise à jour donné.

simulate

 Simule le résultat de l'utilisation d'un SecurityHealthAnalyticsCustomModule pour vérifier une ressource.