Method: folders.locations.securityHealthAnalyticsCustomModules.patch

根据给定更新掩码更新指定名称下的 SecurityHealthAnalyticsCustomModule。常驻模块和继承模块都支持更新启用状态(不过,常驻模块的启用状态不能为“继承”)。只有常驻模块支持更新模块的显示名称和自定义配置。

HTTP 请求

PATCH https://securitycentermanagement.googleapis.com/v1/{securityHealthAnalyticsCustomModule.name=folders/*/locations/*/securityHealthAnalyticsCustomModules/*}

网址采用 gRPC 转码语法。

路径参数

参数
securityHealthAnalyticsCustomModule.name

string

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

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

查询参数

参数
updateMask

string (FieldMask format)

必需。要更新的字段。以下值均有效:

  • customConfig
  • enablementState

如果您省略此字段或将其设置为通配符值 *,则系统会更新所有符合条件的字段。

这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo"

validateOnly

boolean

可选。设置为 true 时,系统会对请求进行验证(包括 IAM 检查),但不会更新任何模块。OK 响应表示请求有效,而错误响应表示请求无效。

即使请求有效,后续更新模块的请求仍可能会因以下某种原因而失败:

  • 您的云资源状态发生了变化;例如,您失去了必要的 IAM 权限
  • 创建模块时出错

默认值为 false

请求正文

请求正文包含一个 SecurityHealthAnalyticsCustomModule 实例。

响应正文

如果成功,则响应正文包含一个 SecurityHealthAnalyticsCustomModule 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

IAM 权限

需要拥有 name 资源的以下 IAM 权限:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.update

如需了解详情,请参阅 IAM 文档