mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-21 14:39:15 +00:00
gcloud: Wed Apr 12 10:43:12 UTC 2023
This commit is contained in:
Automated
parent
32e56b8b99
commit
b155beb241
220 changed files with 7834 additions and 1142 deletions
|
|
@ -1,11 +1,12 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules - manage custom modules
|
||||
gcloud alpha scc custom-modules - manage Cloud SCC
|
||||
(Security Command Center) custom modules
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules GROUP [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Manage custom modules.
|
||||
(ALPHA) Manage Cloud SCC (Security Command Center) custom modules.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
|
@ -16,11 +17,13 @@ GROUPS
|
|||
GROUP is one of the following:
|
||||
|
||||
sha
|
||||
(ALPHA) Manage custom modules.
|
||||
(ALPHA) Manage Security Health Analytics custom modules.
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules
|
||||
|
||||
|
|
|
|||
|
|
@ -21,10 +21,6 @@ EXAMPLES
|
|||
--display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha create --organization=123 \
|
||||
--display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
To create a Security Health Analytics custom module for given folder 456,
|
||||
run:
|
||||
|
|
@ -33,10 +29,6 @@ EXAMPLES
|
|||
--display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha create --folder=456 \
|
||||
--display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
To create a Security Health Analytics custom module for given project 789,
|
||||
run:
|
||||
|
|
@ -45,24 +37,24 @@ EXAMPLES
|
|||
--project=projects/789 --display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha create --project=789 \
|
||||
--display-name="test_display_name" \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
REQUIRED FLAGS
|
||||
--custom-config-from-file=CUSTOM_CONFIG_FROM_FILE
|
||||
Path to a yaml file containing the custom configuration for the
|
||||
Security Health Analytics custom module.
|
||||
Path to a YAML file that contains the configuration for the Security
|
||||
Health Analytics custom module.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
The text that will be used to represent a Security Health Analytics
|
||||
custom module display name. Display name must be at most 64 characters
|
||||
Sets the 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.
|
||||
|
||||
--enablement-state=ENABLEMENT_STATE
|
||||
The enablement state of the Security Health Analytics custom module.
|
||||
ENABLEMENT_STATE must be one of: disabled, enabled,
|
||||
enablement-state-unspecified, inherited.
|
||||
Sets the enablement state of the Security Health Analytics custom
|
||||
module. From the following list of possible enablement states, specify
|
||||
either enabled or disabled only. ENABLEMENT_STATE must be one of:
|
||||
disabled, enabled, enablement-state-unspecified, inherited.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
At most one of these can be specified:
|
||||
|
|
@ -76,8 +68,8 @@ OPTIONAL FLAGS
|
|||
resides. Formatted as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project where the Security Health Analytics
|
||||
custom module resides. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
@ -95,5 +87,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha create
|
||||
|
||||
|
|
|
|||
|
|
@ -11,40 +11,29 @@ DESCRIPTION
|
|||
(ALPHA) Delete a Security Health Analytics custom module.
|
||||
|
||||
EXAMPLES
|
||||
To delete a Security Health Analytics custom module with id 123456 for
|
||||
To delete a Security Health Analytics custom module with ID 123456 for
|
||||
organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 \
|
||||
--organization=123
|
||||
$ gcloud alpha scc custom-modules sha delete \
|
||||
organizations/123/securityHealthAnalyticsSettings/\
|
||||
customModules/123456
|
||||
|
||||
To delete a Security Health Analytics custom module with id 123456 for
|
||||
To delete a Security Health Analytics custom module with ID 123456 for
|
||||
folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 \
|
||||
--folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 --folder=456
|
||||
$ gcloud alpha scc custom-modules sha delete \
|
||||
folders/456/securityHealthAnalyticsSettings/customModules/123456
|
||||
|
||||
To delete a Security Health Analytics custom module with id 123456 for
|
||||
To delete a Security Health Analytics custom module with ID 123456 for
|
||||
project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 \
|
||||
--project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha delete 123456 --project=789
|
||||
$ gcloud alpha scc custom-modules sha delete \
|
||||
projects/789/securityHealthAnalyticsSettings/customModules/\
|
||||
123456
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
CUSTOM_MODULE
|
||||
Id or the full resource name of the Security Health Analytics custom
|
||||
module.
|
||||
ID or the full resource name of the Security Health Analytics custom
|
||||
module. If you specify the full resource name, you do not need to
|
||||
specify the --organization, --folder, or --project flags.
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
|
@ -58,8 +47,8 @@ FLAGS
|
|||
resides. Formatted as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project where the Security Health Analytics
|
||||
custom module resides. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
@ -77,5 +66,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha delete
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha get - get a Security Health Analytics
|
||||
custom module
|
||||
gcloud alpha scc custom-modules sha get - get the details of a Security
|
||||
Health Analytics custom module
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha get CUSTOM_MODULE
|
||||
|
|
@ -8,56 +8,52 @@ SYNOPSIS
|
|||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Get a Security Health Analytics custom module.
|
||||
(ALPHA) Get the details of a Security Health Analytics custom module. It
|
||||
does not resolve INHERITED enablement states to ENABLED or DISABLED for
|
||||
modules created at ancestor levels. For example, if the module is enabled
|
||||
at the ancestor level, modules for all child resources will have the
|
||||
enablement state set to INHERITED. Use gcloud scc custom-modules sha
|
||||
get-effective to retrieve a custom module with its effective enablement
|
||||
state.
|
||||
|
||||
EXAMPLES
|
||||
To get a Security Health Analytics custom module with id 123456 for
|
||||
organization 123, run:
|
||||
To get the details of a Security Health Analytics custom module with ID
|
||||
123456 for organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get 123456 \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha get 123456 --organization=123
|
||||
$ gcloud alpha scc custom-modules sha get \
|
||||
organizations/123/securityHealthAnalyticsSettings/\
|
||||
customModules/123456
|
||||
|
||||
To get a Security Health Analytics custom module with id 123456 for folder
|
||||
456, run:
|
||||
To get the details of a Security Health Analytics custom module with ID
|
||||
123456 for folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get 123456 --folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha get 123456 --folder=456
|
||||
$ gcloud alpha scc custom-modules sha get \
|
||||
folders/456/securityHealthAnalyticsSettings/customModules/123456
|
||||
|
||||
To get a Security Health Analytics custom module with id 123456 for project
|
||||
789, run:
|
||||
To get the details of a Security Health Analytics custom module with ID
|
||||
123456 for project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get 123456 \
|
||||
--project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha get 123456 --project=789
|
||||
$ gcloud alpha scc custom-modules sha get \
|
||||
projects/789/securityHealthAnalyticsSettings/customModules/\
|
||||
123456
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
CUSTOM_MODULE
|
||||
Id or the full resource name of the Security Health Analytics custom
|
||||
module.
|
||||
ID or the full resource name of the Security Health Analytics custom
|
||||
module. If you specify the full resource name, you do not need to
|
||||
specify the --organization, --folder, or --project flags.
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--folder=FOLDER
|
||||
Folder where the Security Health Analytics custom module resides.
|
||||
Formatted as folders/456 or just 456.
|
||||
Folder from which to get the custom module details. Formatted as
|
||||
folders/456 or just 456.
|
||||
|
||||
--organization=ORGANIZATION
|
||||
Organization where the Security Health Analytics custom module
|
||||
resides. Formatted as organizations/123 or just 123.
|
||||
Organization from which to get the custom module details. Formatted
|
||||
as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project from which to get the custom module
|
||||
details. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
@ -75,5 +71,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha get
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha get-effective - get an effective
|
||||
Security Health Analytics custom module
|
||||
gcloud alpha scc custom-modules sha get-effective - get the details of a
|
||||
Security Health Analytics custom module with effective enablement state
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha get-effective CUSTOM_MODULE
|
||||
|
|
@ -8,61 +8,52 @@ SYNOPSIS
|
|||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Get an effective Security Health Analytics custom module.
|
||||
(ALPHA) Get the details of a Security Health Analytics custom module. For
|
||||
inherited custom modules, the get-effective command resolves INHERITED
|
||||
enablement states to ENABLED or DISABLED. For example, if an inherited
|
||||
custom module is enabled at the ancestor level, then the get-effective
|
||||
command displays the enablement state as ENABLED instead of INHERITED in a
|
||||
child folder or project.
|
||||
|
||||
EXAMPLES
|
||||
To get an effective Security Health Analytics custom module with id 123456
|
||||
for organization 123, run:
|
||||
To get the details of a Security Health Analytics custom module 123456 with
|
||||
its effective enablement state from organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--organization=123
|
||||
$ gcloud alpha scc custom-modules sha get-effective \
|
||||
organizations/123/securityHealthAnalyticsSettings/\
|
||||
effectiveCustomModules/123456
|
||||
|
||||
To get an effective Security Health Analytics custom module with id 123456
|
||||
for folder 456, run:
|
||||
To get the details of a Security Health Analytics custom module 123456 with
|
||||
its effective enablement state from folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--folder=456
|
||||
$ gcloud alpha scc custom-modules sha get-effective \
|
||||
folders/456/securityHealthAnalyticsSettings/\
|
||||
effectiveCustomModules/123456
|
||||
|
||||
To get an effective Security Health Analytics custom module with id 123456
|
||||
for project 789, run:
|
||||
To get the details of a Security Health Analytics custom module 123456 with
|
||||
its effective enablement state from project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha get-effective 123456 \
|
||||
--project=789
|
||||
$ gcloud alpha scc custom-modules sha get-effective \
|
||||
projects/789/securityHealthAnalyticsSettings/\
|
||||
effectiveCustomModules/123456
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
CUSTOM_MODULE
|
||||
Id or the full resource name of the effective Security Health Analytics
|
||||
custom module.
|
||||
ID or the full resource name of the effective Security Health Analytics
|
||||
custom module. If you specify the full resource name, you do not need
|
||||
to specify the --organization, --folder, or --project flags.
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--folder=FOLDER
|
||||
Folder where the effective Security Health Analytics custom module
|
||||
resides. Formatted as folders/456 or just 456.
|
||||
Folder from which to get the custom module details. Formatted as
|
||||
folders/456 or just 456.
|
||||
|
||||
--organization=ORGANIZATION
|
||||
Organization where the effective Security Health Analytics custom
|
||||
module resides. Formatted as organizations/123 or just 123.
|
||||
Organization from which to get the custom module details. Formatted
|
||||
as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the effective Security Health Analytics
|
||||
custom module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project from which to get the custom module
|
||||
details. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
@ -80,5 +71,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha get-effective
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha - manage custom modules
|
||||
gcloud alpha scc custom-modules sha - manage Security Health Analytics
|
||||
custom modules
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Manage custom modules.
|
||||
(ALPHA) Manage Security Health Analytics custom modules.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
|
@ -22,19 +23,22 @@ COMMANDS
|
|||
(ALPHA) Delete a Security Health Analytics custom module.
|
||||
|
||||
get
|
||||
(ALPHA) Get a Security Health Analytics custom module.
|
||||
(ALPHA) Get the details of a Security Health Analytics custom module.
|
||||
|
||||
get-effective
|
||||
(ALPHA) Get an effective Security Health Analytics custom module.
|
||||
(ALPHA) Get the details of a Security Health Analytics custom module
|
||||
with effective enablement state.
|
||||
|
||||
list
|
||||
(ALPHA) List Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of Security Health Analytics custom modules.
|
||||
|
||||
list-descendant
|
||||
(ALPHA) List Descendant Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of the resident and descendant Security Health
|
||||
Analytics custom modules.
|
||||
|
||||
list-effective
|
||||
(ALPHA) List Effective Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of Security Health Analytics custom modules
|
||||
with effective enablement states.
|
||||
|
||||
test
|
||||
(ALPHA) Test a Security Health Analytics custom module.
|
||||
|
|
@ -46,5 +50,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha list - list Security Health Analytics
|
||||
custom modules
|
||||
gcloud alpha scc custom-modules sha list - list the details of Security
|
||||
Health Analytics custom modules
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha list
|
||||
|
|
@ -9,40 +9,48 @@ SYNOPSIS
|
|||
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of the resident and inherited Security Health
|
||||
Analytics custom modules for the specified folder or project. For an
|
||||
organization, this command lists only the custom modules that are created
|
||||
at the organization level. Custom modules created in child folders or
|
||||
projects are not included in the list. To list the resident custom modules
|
||||
and the modules that are created in child folders or projects, use gcloud
|
||||
scc custom-modules sha list-descendant.
|
||||
|
||||
EXAMPLES
|
||||
To list Security Health Analytics custom modules under organization 123,
|
||||
run:
|
||||
To list resident and inherited Security Health Analytics custom modules for
|
||||
organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha list --organization=123
|
||||
|
||||
To list Security Health Analytics custom modules under folder 456, run:
|
||||
To list resident and inherited Security Health Analytics custom modules for
|
||||
folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list --folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha list --folder=456
|
||||
|
||||
To list Security Health Analytics custom modules under project 789, run:
|
||||
To list resident and inherited Security Health Analytics custom modules for
|
||||
project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list --project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha list --project=789
|
||||
|
||||
REQUIRED FLAGS
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--folder=FOLDER
|
||||
Folder where the Security Health Analytics custom modules resides.
|
||||
Formatted as folders/456 or just 456.
|
||||
Folder for listing the Security Health Analytics custom modules
|
||||
created at the current folder level and inherited modules from CRM
|
||||
ancestors. Formatted as folders/456 or just 456.
|
||||
|
||||
--organization=ORGANIZATION
|
||||
Organization where the Security Health Analytics custom modules
|
||||
resides. Formatted as organizations/123 or just 123.
|
||||
Organization for listing the Security Health Analytics custom modules
|
||||
created at the organization level. Formatted as organizations/123 or
|
||||
just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
modules resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project for listing the Security Health Analytics
|
||||
custom modules created at current project level and inherited modules
|
||||
from CRM ancestors. Formatted as projects/789 or just 789.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
|
|
@ -86,5 +94,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha list
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha list-descendant - list Descendant
|
||||
Security Health Analytics custom modules
|
||||
gcloud alpha scc custom-modules sha list-descendant - list the details of
|
||||
the resident and descendant Security Health Analytics custom modules
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha list-descendant
|
||||
|
|
@ -9,45 +9,50 @@ SYNOPSIS
|
|||
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List Descendant Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of the resident and descendant Security Health
|
||||
Analytics custom modules for a specified organization or folder. For a
|
||||
project, this command lists only the custom modules that are created in the
|
||||
project. Modules created in a parent organization or folder are excluded
|
||||
from the list. To list the resident custom modules and the modules that are
|
||||
inherited from a parent organization and folder, use gcloud scc
|
||||
custom-modules sha list.
|
||||
|
||||
EXAMPLES
|
||||
To list Descendant Security Health Analytics custom modules under
|
||||
organization 123, run:
|
||||
To list resident and descendant Security Health Analytics custom modules
|
||||
for organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-descendant \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha list-descendant \
|
||||
--organization=123
|
||||
|
||||
To list Descendant Security Health Analytics custom modules under folder
|
||||
456, run:
|
||||
To list resident and descendant Security Health Analytics custom modules
|
||||
for folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-descendant \
|
||||
--folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha list-descendant --folder=456
|
||||
|
||||
To list Descendant Security Health Analytics custom modules under project
|
||||
789, run:
|
||||
To list resident and descendant Security Health Analytics custom modules
|
||||
for project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-descendant \
|
||||
--project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha list-descendant --project=789
|
||||
|
||||
REQUIRED FLAGS
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--folder=FOLDER
|
||||
Folder where the Descendant Security Health Analytics custom modules
|
||||
resides. Formatted as folders/456 or just 456.
|
||||
Folder for listing the Security Health Analytics custom modules
|
||||
created at the current folder level and its child resources.
|
||||
Formatted as folders/456 or just 456.
|
||||
|
||||
--organization=ORGANIZATION
|
||||
Organization where the Descendant Security Health Analytics custom
|
||||
modules resides. Formatted as organizations/123 or just 123.
|
||||
Organization for listing the Security Health Analytics custom modules
|
||||
created at the organization level and its child resources. Formatted
|
||||
as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Descendant Security Health Analytics
|
||||
custom modules resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project for listing the Security Health Analytics
|
||||
custom modules at current project level. Formatted as projects/789 or
|
||||
just 789.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
|
|
@ -91,5 +96,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha list-descendant
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
NAME
|
||||
gcloud alpha scc custom-modules sha list-effective - list Effective
|
||||
Security Health Analytics custom modules
|
||||
gcloud alpha scc custom-modules sha list-effective - list the details of
|
||||
Security Health Analytics custom modules with effective enablement
|
||||
states
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha scc custom-modules sha list-effective
|
||||
|
|
@ -9,45 +10,48 @@ SYNOPSIS
|
|||
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List Effective Security Health Analytics custom modules.
|
||||
(ALPHA) List the details of resident and inherited Security Health
|
||||
Analytics custom modules for the specified folder or project with their
|
||||
effective enablement states. For an organization, this command lists only
|
||||
the custom modules that are created at the organization level. Custom
|
||||
modules created in child folders or projects are not included in the list.
|
||||
|
||||
EXAMPLES
|
||||
To list Effective Security Health Analytics custom modules under
|
||||
organization 123, run:
|
||||
To list resident and inherited Security Health Analytics custom modules
|
||||
with effective enablement states for organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-effective \
|
||||
--organization=organizations/123
|
||||
$ gcloud alpha scc custom-modules sha list-effective \
|
||||
--organization=123
|
||||
|
||||
To list Effective Security Health Analytics custom modules under folder
|
||||
456, run:
|
||||
To list resident and inherited effective Security Health Analytics custom
|
||||
modules with effective enablement states for folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-effective \
|
||||
--folder=folders/456
|
||||
$ gcloud alpha scc custom-modules sha list-effective --folder=456
|
||||
|
||||
To list Effective Security Health Analytics custom modules under project
|
||||
789, run:
|
||||
To list resident and inherited effective Security Health Analytics custom
|
||||
modules with effective enablement states for project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha list-effective \
|
||||
--project=projects/789
|
||||
$ gcloud alpha scc custom-modules sha list-effective --project=789
|
||||
|
||||
REQUIRED FLAGS
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--folder=FOLDER
|
||||
Folder where the Effective Security Health Analytics custom modules
|
||||
resides. Formatted as folders/456 or just 456.
|
||||
Folder for listing the effective Security Health Analytics custom
|
||||
modules created at the current folder level and inherited modules
|
||||
from CRM ancestors. Formatted as folders/456 or just 456.
|
||||
|
||||
--organization=ORGANIZATION
|
||||
Organization where the Effective Security Health Analytics custom
|
||||
modules resides. Formatted as organizations/123 or just 123.
|
||||
Organization for listing the effective Security Health Analytics
|
||||
custom modules created at the organization level. Formatted as
|
||||
organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Effective Security Health Analytics
|
||||
custom modules resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project for listing the effective Security Health
|
||||
Analytics custom modules for the current project level and inherited
|
||||
modules from CRM ancestors. Formatted as projects/789 or just 789.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
|
|
@ -91,5 +95,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha list-effective
|
||||
|
||||
|
|
|
|||
|
|
@ -14,74 +14,54 @@ DESCRIPTION
|
|||
(ALPHA) Test a Security Health Analytics custom module.
|
||||
|
||||
EXAMPLES
|
||||
To test a Security Health Analytics custom module with id 123456 for
|
||||
To test a Security Health Analytics custom module with ID 123456 for
|
||||
organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha test 123456 \
|
||||
--organization=organizations/123 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test 123456 \
|
||||
--organization=123 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test \
|
||||
organizations/123/securityHealthAnalyticsSettings/\
|
||||
customModules/123456 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
--display-name="test_display_name" \
|
||||
--custom-config-from-file=/tmp/custom_config.yaml \
|
||||
--test-data-from-file=/tmp/test_data.yaml
|
||||
|
||||
To test a Security Health Analytics custom module with id 123456 for folder
|
||||
To test a Security Health Analytics custom module with ID 123456 for folder
|
||||
456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha test 123456 \
|
||||
--folder=folders/456 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test 123456 --folder=456 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test \
|
||||
folders/456/securityHealthAnalyticsSettings/customModules/\
|
||||
123456 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
--folder=folders/456 --display-name="test_display_name" \
|
||||
--custom-config-from-file=/tmp/custom_config.yaml \
|
||||
--test-data-from-file=/tmp/test_data.yaml
|
||||
|
||||
To test a Security Health Analytics custom module with id 123456 for
|
||||
To test a Security Health Analytics custom module with ID 123456 for
|
||||
project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha test 123456 \
|
||||
--project=projects/789 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test 123456 --project=789 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
$ gcloud alpha scc custom-modules sha test \
|
||||
projects/789/securityHealthAnalyticsSettings/customModules/\
|
||||
123456 \
|
||||
--display-name="test_display_name"--custom-config-from-file=/\
|
||||
tmp/custom_config.yaml --test-data-from-file=/tmp/test_data.yaml
|
||||
--project=projects/789 --display-name="test_display_name" \
|
||||
--custom-config-from-file=/tmp/custom_config.yaml \
|
||||
--test-data-from-file=/tmp/test_data.yaml
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
CUSTOM_MODULE
|
||||
Id or the full resource name of the Security Health Analytics custom
|
||||
module.
|
||||
ID or the full resource name of the Security Health Analytics custom
|
||||
module. If you specify the full resource name, you do not need to
|
||||
specify the --organization, --folder, or --project flags.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--test-data-from-file=TEST_DATA_FROM_FILE
|
||||
Path to a YAML file containing the resource data to test the Security
|
||||
Health Analytics custom module against.
|
||||
Path to a YAML file that contains the resource data to test the
|
||||
Security Health Analytics custom module against.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--custom-config-from-file=CUSTOM_CONFIG_FROM_FILE
|
||||
Path to a YAML file containing the custom configuration for the
|
||||
Security Health Analytics custom module. If not specified, the existing
|
||||
module with the given ID or resource name is used.
|
||||
Path to a YAML file that contains the configuration for the Security
|
||||
Health Analytics custom module. If not specified, the existing module
|
||||
with the given ID or resource name is used.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
Display name of the Security Health Analytics custom module. Display
|
||||
name must be at most 64 characters. Only relevant when
|
||||
Sets the display name of the Security Health Analytics custom module.
|
||||
This display name becomes the finding category for all findings that
|
||||
are returned by this the custom module. The display name must be
|
||||
between 1 and 128 characters, start with a lowercase letter, and
|
||||
contain alphanumeric characters or underscores only. Only relevant when
|
||||
--custom-config-from-file is also specified.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
|
@ -95,8 +75,8 @@ OPTIONAL FLAGS
|
|||
resides. Formatted as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project where the Security Health Analytics
|
||||
custom module resides. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
|
|||
|
|
@ -13,62 +13,43 @@ DESCRIPTION
|
|||
(ALPHA) Update a Security Health Analytics custom module.
|
||||
|
||||
EXAMPLES
|
||||
To update a Security Health Analytics custom module with id 123456 for
|
||||
To update a Security Health Analytics custom module with ID 123456 for
|
||||
organization 123, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha update 123456 \
|
||||
--organization=organizations/123 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update 123456 \
|
||||
--organization=123 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update \
|
||||
organizations/123/securityHealthAnalyticsSettings/\
|
||||
customModules/123456 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
To update a Security Health Analytics custom module with id 123456 for
|
||||
To update a Security Health Analytics custom module with ID 123456 for
|
||||
folder 456, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha update 123456 \
|
||||
--folder=folders/456 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update 123456 --folder=456 \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update \
|
||||
folders/456/securityHealthAnalyticsSettings/customModules/\
|
||||
123456 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
To update a Security Health Analytics custom module with id 123456 for
|
||||
To update a Security Health Analytics custom module with ID 123456 for
|
||||
project 789, run:
|
||||
|
||||
$ gcloud alpha scc custom-modules sha update 123456 \
|
||||
--project=projects/789 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update 123456 --project=789 \
|
||||
--enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
$ gcloud alpha scc custom-modules sha update \
|
||||
projects/789/securityHealthAnalyticsSettings/customModules/\
|
||||
123456 --enablement-state="ENABLED" \
|
||||
--custom-config-from-file=custom_config.yaml
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
CUSTOM_MODULE
|
||||
Id or the full resource name of the Security Health Analytics custom
|
||||
module.
|
||||
ID or the full resource name of the Security Health Analytics custom
|
||||
module. If you specify the full resource name, you do not need to
|
||||
specify the --organization, --folder, or --project flags.
|
||||
|
||||
FLAGS
|
||||
--custom-config-from-file=CUSTOM_CONFIG_FROM_FILE
|
||||
Path to a yaml file containing the custom configuration for the
|
||||
Security Health Analytics custom module.
|
||||
Path to a YAML file that contains the configuration for the Security
|
||||
Health Analytics custom module.
|
||||
|
||||
--enablement-state=ENABLEMENT_STATE
|
||||
The enablement state of the Security Health Analytics custom module.
|
||||
ENABLEMENT_STATE must be one of: disabled, enabled,
|
||||
enablement-state-unspecified, inherited.
|
||||
Sets the enablement state of the Security Health Analytics custom
|
||||
module. From the following list of possible enablement states, specify
|
||||
either enabled, disabled or inherited only. ENABLEMENT_STATE must be
|
||||
one of: disabled, enabled, enablement-state-unspecified, inherited.
|
||||
|
||||
--update-mask=UPDATE_MASK
|
||||
Optional: If left unspecified (default), an update-mask is
|
||||
|
|
@ -86,8 +67,8 @@ FLAGS
|
|||
resides. Formatted as organizations/123 or just 123.
|
||||
|
||||
--project=PROJECT
|
||||
Project (id or number) where the Security Health Analytics custom
|
||||
module resides. Formatted as projects/789 or just 789.
|
||||
ID or number of the project where the Security Health Analytics
|
||||
custom module resides. Formatted as projects/789 or just 789.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
|
|
@ -105,5 +86,7 @@ NOTES
|
|||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
access allowlist. This variant is also available:
|
||||
|
||||
$ gcloud scc custom-modules sha update
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue