1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-13 08:27:05 +00:00
gcloud-help/gcloud/alpha/kms/key-handles/list
2025-02-20 10:40:27 +00:00

98 lines
4 KiB
Text

NAME
gcloud alpha kms key-handles list - list KeyHandle resources within a
project and location
SYNOPSIS
gcloud alpha kms key-handles list --location=LOCATION
--resource-type=RESOURCE_TYPE [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Lists all KeyHandle resources within a given project and location.
Addtionally, can filter the list.
EXAMPLES
The following command lists a maximum of five KeyHandle resources in the
location global:
$ gcloud alpha kms key-handles list --location=global --limit=5
The following command lists all KeyHandle resources in the location global
that have a resource type selector of compute.googleapis.com/Instance:
$ gcloud alpha kms key-handles list --location=global \
--resource-type=compute.googleapis.com/Instance
REQUIRED FLAGS
Location resource - The KMS location resource. This represents a Cloud
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 --location on the command line with a fully
specified name;
◆ set the property core/project.
This must be specified.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
--resource-type=RESOURCE_TYPE
The resource type selector for KeyHandle resources of the form
{SERVICE}.{UNIVERSE_DOMAIN}/{TYPE}.
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
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. These variants are also available:
$ gcloud kms key-handles list
$ gcloud beta kms key-handles list