1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 02:25:19 +00:00

gcloud: Thu Jun 8 11:29:23 UTC 2023

This commit is contained in:
Automated 2023-06-08 11:29:23 +00:00
parent 91de7103bb
commit 435c9359b5
115 changed files with 1566 additions and 491 deletions

View file

@ -37,6 +37,9 @@ GROUPS
import-jobs
Create and manage import jobs.
inventory
Manages the KMS Inventory and Key Tracking commands.
keyrings
Create and manage keyrings.

View file

@ -0,0 +1,75 @@
NAME
gcloud kms inventory get-protected-resources-summary - gets the protected
resources summary
SYNOPSIS
gcloud kms inventory get-protected-resources-summary
(--keyname=KEYNAME : --keyring=KEYRING --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud kms inventory get-protected-resources-summary returns a summary of
the resources a key is protecting.
The summary includes how many projects contain protected resources, how
many protected resources there are, what are the types of protected
resources, and the count for each type of protected resource.
EXAMPLES
To view the summary of protected resources for the key puppy, run:
$ gcloud kms inventory get-protected-resources-summary \
--keyname=puppy
REQUIRED FLAGS
Key resource - The KMS key resource. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument --keyname on the command line with a fully
specified name;
◆ set the property core/project.
This must be specified.
--keyname=KEYNAME
ID of the key or fully qualified identifier for the key.
To set the key attribute:
▸ provide the argument --keyname on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--keyring=KEYRING
The KMS keyring of the key.
To set the keyring attribute:
▸ provide the argument --keyname on the command line with a fully
specified name;
▸ provide the argument --keyring on the command line.
--location=LOCATION
The Google Cloud location for the key.
To set the location attribute:
▸ provide the argument --keyname on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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.
NOTES
These variants are also available:
$ gcloud alpha kms inventory get-protected-resources-summary
$ gcloud beta kms inventory get-protected-resources-summary

33
gcloud/kms/inventory/help Normal file
View file

@ -0,0 +1,33 @@
NAME
gcloud kms inventory - manages the KMS Inventory and Key Tracking commands
SYNOPSIS
gcloud kms inventory COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manages the KMS Inventory and Key Tracking commands.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
get-protected-resources-summary
Gets the protected resources summary.
list-keys
Lists the keys in a project.
search-protected-resources
Searches the resources protected by a key.
NOTES
These variants are also available:
$ gcloud alpha kms inventory
$ gcloud beta kms inventory

View file

@ -0,0 +1,67 @@
NAME
gcloud kms inventory list-keys - lists the keys in a project
SYNOPSIS
gcloud kms inventory list-keys [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud kms inventory list-keys lists the keys in the specified project.
EXAMPLES
To view the keys in the default project, run:
$ gcloud kms inventory list-keys
To view the keys in project jellyfish, run:
$ gcloud kms inventory list-keys --project=jellyfish
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.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
NOTES
These variants are also available:
$ gcloud alpha kms inventory list-keys
$ gcloud beta kms inventory list-keys

View file

@ -0,0 +1,108 @@
NAME
gcloud kms inventory search-protected-resources - searches the resources
protected by a key
SYNOPSIS
gcloud kms inventory search-protected-resources --scope=ORGANIZATION_ID
(--keyname=KEYNAME : --keyring=KEYRING --location=LOCATION)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
gcloud kms inventory search-protected-resources returns a list of the
resources a key is protecting within the specified organization.
EXAMPLES
To view the protected resources for the key puppy and organization number
1234 run:
$ gcloud kms inventory search-protected-resources --keyname=puppy \
--scope=1234
REQUIRED FLAGS
--scope=ORGANIZATION_ID
Organization ID.
Key resource - The KMS key resource. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument --keyname on the command line with a fully
specified name;
◆ set the property core/project.
This must be specified.
--keyname=KEYNAME
ID of the key or fully qualified identifier for the key.
To set the key attribute:
▸ provide the argument --keyname on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--keyring=KEYRING
The KMS keyring of the key.
To set the keyring attribute:
▸ provide the argument --keyname on the command line with a fully
specified name;
▸ provide the argument --keyring on the command line.
--location=LOCATION
The Google Cloud location for the key.
To set the location attribute:
▸ provide the argument --keyname on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
NOTES
These variants are also available:
$ gcloud alpha kms inventory search-protected-resources
$ gcloud beta kms inventory search-protected-resources