REST Resource: folders.locations.securityHealthAnalyticsCustomModules

资源：SecurityHealthAnalyticsCustomModule

表示 Security Health Analytics 自定义模块的实例，包括其完整模块名称、显示名称、启用状态和上次更新时间。您可以在组织、文件夹或项目级创建自定义模块。您在组织级或文件夹级创建的自定义模块会被后代文件夹和项目继承。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "enablementState": enum (EnablementState),
  "updateTime": string,
  "lastEditor": string,
  "ancestorModule": string,
  "customConfig": {
    object (CustomConfig)
  }
}
字段
name

string

标识符。自定义模块的完整资源名称，采用以下格式之一：

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

string

可选。Security Health Analytics 自定义模块的显示名称。此显示名称将成为此自定义模块返回的所有发现结果的类别。显示名称必须介于 1 到 128 个字符之间，以小写字母开头，并且只能包含字母数字字符或下划线。
enablementState

enum (EnablementState)

可选。自定义模块的启用状态。
updateTime

string (Timestamp format)

仅限输出。自定义模块上次更新的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
lastEditor

string

仅限输出。上次更新自定义模块的编辑者。
ancestorModule

string

仅限输出。指定自定义模块继承自的组织或文件夹。如果为空，则表示自定义模块是在您查看该自定义模块的组织、文件夹或项目中创建的。
customConfig

object (CustomConfig)

可选。用户为模块指定的自定义配置。

EnablementState

自定义模块的可能启用状态。

枚举
ENABLEMENT_STATE_UNSPECIFIED 默认值。此值未使用。
ENABLED 在给定组织、文件夹或项目中启用了该模块。
DISABLED 模块在指定的组织、文件夹或项目中处于停用状态。
INHERITED 状态会从父级模块继承。该模块实际上将是 ENABLED 或 DISABLED，具体取决于其在资源层次结构中最近的非继承祖先模块。如果您尝试将顶级模块（没有父级的模块）设为 INHERITED 状态，则会收到 INVALID_ARGUMENT 错误。

方法

create

 在给定组织、文件夹或项目的范围内创建常驻 SecurityHealthAnalyticsCustomModule，并为给定父级的所有子文件夹和子项目创建继承的 SecurityHealthAnalyticsCustomModule 资源。

delete

 删除指定的 SecurityHealthAnalyticsCustomModule 及其在资源层次结构中的所有后代。

get

 检索 SecurityHealthAnalyticsCustomModule。

list

 返回指定父级的所有 SecurityHealthAnalyticsCustomModule 资源的列表。

listDescendant

 返回给定组织、文件夹或项目及其所有后代下的所有常驻 SecurityHealthAnalyticsCustomModule 资源的列表。

patch

 根据给定更新掩码更新指定名称下的 SecurityHealthAnalyticsCustomModule。

simulate

 模拟使用 SecurityHealthAnalyticsCustomModule 检查资源的结果。