- 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
) [--resource-types
=[RESOURCE_TYPES
,…]] [--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 number1234
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.
-
provide the argument
--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.
-
provide the argument
--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.
-
provide the argument
-
provide the argument
- FLAGS
-
--resource-types
=[RESOURCE_TYPES
,…]-
A list of resource types that this request searches for. If empty, it will
search all the trackable
resource types.
Regular expressions are also supported. For example:
-
snapshots resources whose type starts withcompute.googleapis.com.*
.compute.googleapis.com
-
snapshots resources whose type ends with.*Image
.Image
-
snapshots resources whose type contains.*Image.*
.Image
See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an
error will be returned.INVALID_ARGUMENT
-
- LIST COMMAND FLAGS
-
--filter
=EXPRESSION
-
Apply a Boolean filter
EXPRESSION
to each resource item to be listed. If the expression evaluatesTrue
, 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 theuri()
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.