Skip to main content

security_health_analytics_modules

Overview

Namesecurity_health_analytics_modules
TypeResource
Idgoogle.securitycenter.security_health_analytics_modules

Fields

NameDatatypeDescription
namestringImmutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
ancestorModulestringOutput only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
customConfigobjectDefines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.
displayNamestringThe display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
enablementStatestringThe enablement state of the custom module.
lastEditorstringOutput only. The editor that last updated the custom module.
updateTimestringOutput only. The time at which the custom module was last updated.

Methods

NameAccessible byRequired ParamsDescription
folders_security_health_analytics_settings_custom_modules_getSELECTcustomModulesId, foldersIdRetrieves a SecurityHealthAnalyticsCustomModule.
folders_security_health_analytics_settings_custom_modules_listSELECTfoldersIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
organizations_security_health_analytics_settings_custom_modules_getSELECTcustomModulesId, organizationsIdRetrieves a SecurityHealthAnalyticsCustomModule.
organizations_security_health_analytics_settings_custom_modules_listSELECTorganizationsIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
projects_security_health_analytics_settings_custom_modules_getSELECTcustomModulesId, projectsIdRetrieves a SecurityHealthAnalyticsCustomModule.
projects_security_health_analytics_settings_custom_modules_listSELECTprojectsIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
folders_security_health_analytics_settings_custom_modules_createINSERTfoldersIdCreates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
organizations_security_health_analytics_settings_custom_modules_createINSERTorganizationsIdCreates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
projects_security_health_analytics_settings_custom_modules_createINSERTprojectsIdCreates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
folders_security_health_analytics_settings_custom_modules_deleteDELETEcustomModulesId, foldersIdDeletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
organizations_security_health_analytics_settings_custom_modules_deleteDELETEcustomModulesId, organizationsIdDeletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
projects_security_health_analytics_settings_custom_modules_deleteDELETEcustomModulesId, projectsIdDeletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
_folders_security_health_analytics_settings_custom_modules_listEXECfoldersIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
_organizations_security_health_analytics_settings_custom_modules_listEXECorganizationsIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
_projects_security_health_analytics_settings_custom_modules_listEXECprojectsIdReturns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.