1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 12:22:03 +00:00
gcloud-help/gcloud/alpha/scc/custom-modules/sha/list-effective

102 lines
4.4 KiB
Text
Raw Normal View History

2022-08-17 09:22:03 +00:00
NAME
2023-04-12 10:43:12 +00:00
gcloud alpha scc custom-modules sha list-effective - list the details of
Security Health Analytics custom modules with effective enablement
states
2022-08-17 09:22:03 +00:00
SYNOPSIS
2023-02-08 10:13:59 +00:00
gcloud alpha scc custom-modules sha list-effective
(--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT)
2022-08-17 09:22:03 +00:00
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
2023-04-12 10:43:12 +00:00
(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.
2022-08-17 09:22:03 +00:00
EXAMPLES
2023-04-12 10:43:12 +00:00
To list resident and inherited Security Health Analytics custom modules
with effective enablement states for organization 123, run:
2023-02-08 10:13:59 +00:00
$ gcloud alpha scc custom-modules sha list-effective \
--organization=organizations/123
2023-04-12 10:43:12 +00:00
To list resident and inherited effective Security Health Analytics custom
modules with effective enablement states for folder 456, run:
2022-08-17 09:22:03 +00:00
2023-02-08 10:13:59 +00:00
$ gcloud alpha scc custom-modules sha list-effective \
--folder=folders/456
2022-08-17 09:22:03 +00:00
2023-04-12 10:43:12 +00:00
To list resident and inherited effective Security Health Analytics custom
modules with effective enablement states for project 789, run:
2022-08-17 09:22:03 +00:00
2023-02-08 10:13:59 +00:00
$ gcloud alpha scc custom-modules sha list-effective \
--project=projects/789
2022-08-17 09:22:03 +00:00
2023-02-08 10:13:59 +00:00
REQUIRED FLAGS
Exactly one of these must be specified:
2022-08-17 09:22:03 +00:00
2023-02-08 10:13:59 +00:00
--folder=FOLDER
2023-04-12 10:43:12 +00:00
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.
2023-02-08 10:13:59 +00:00
--organization=ORGANIZATION
2023-04-12 10:43:12 +00:00
Organization for listing the effective Security Health Analytics
custom modules created at the organization level. Formatted as
organizations/123 or just 123.
2023-02-08 10:13:59 +00:00
--project=PROJECT
2023-04-12 10:43:12 +00:00
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.
2022-08-17 09:22:03 +00:00
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
2023-02-08 10:13:59 +00:00
API REFERENCE
This command uses the securitycenter/v1 API. The full documentation for
this API can be found at: https://cloud.google.com/security-command-center
2022-08-17 09:22:03 +00:00
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
2023-04-12 10:43:12 +00:00
access allowlist. This variant is also available:
$ gcloud scc custom-modules sha list-effective
2022-08-17 09:22:03 +00:00