gcloud beta kms inventory search-protected-resources Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta kms inventory search-protected-resources - searches the resources protected by a key
- SYNOPSIS
gcloud beta 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
(BETA)gcloud beta kms inventorysearch-protected-resourcesreturns a list of the resources a key isprotecting within the specified organization.- EXAMPLES
- To view the protected resources for the key
puppyand organizationnumber1234run:gcloudbetakmsinventorysearch-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 tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
--keynameon the command line with a fullyspecified 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
keyattribute:- provide the argument
--keynameon the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--keyring=KEYRING- The KMS keyring of the key.
To set the
keyringattribute:- provide the argument
--keynameon the command line with a fullyspecified name; - provide the argument
--keyringon the command line.
- provide the argument
--location=LOCATION- The Google Cloud location for the key.
To set the
locationattribute:- provide the argument
--keynameon the command line with a fullyspecified name; - provide the argument
--locationon 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 willsearch all thetrackableresource types.
Regular expressions are also supported. For example:
snapshotsresources whose type starts withcompute.googleapis.com.*.compute.googleapis.comsnapshots resources whose type endswith.*Image.Imagesnapshots resources whose typecontains.*Image.*.Image
SeeRE2 for allsupported regular expression syntax. If the regular expression does not matchany supported resource type, an
error will be returned.INVALID_ARGUMENT
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts 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. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it is
unlimited(no paging).Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]- Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. 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 thecommand output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To displayURIs 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 helpfor details. - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudkmsinventorysearch-protected-resourcesgcloudalphakmsinventorysearch-protected-resources
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.