.TH "GCLOUD_KMS_INVENTORY_SEARCH\-PROTECTED\-RESOURCES" 1



.SH "NAME"
.HP
gcloud kms inventory search\-protected\-resources \- searches the resources protected by a key



.SH "SYNOPSIS"
.HP
\f5gcloud kms inventory search\-protected\-resources\fR \fB\-\-scope\fR=\fIORGANIZATION_ID\fR (\fB\-\-keyname\fR=\fIKEYNAME\fR\ :\ \fB\-\-keyring\fR=\fIKEYRING\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-resource\-types\fR=[\fIRESOURCE_TYPES\fR,...]] [\fB\-\-filter\fR=\fIEXPRESSION\fR] [\fB\-\-limit\fR=\fILIMIT\fR] [\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR] [\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]] [\fB\-\-uri\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fBgcloud kms inventory search\-protected\-resources\fR returns a list of the
resources a key is protecting within the specified organization.



.SH "EXAMPLES"

To view the protected resources for the key \f5puppy\fR and organization number
\f51234\fR run:

.RS 2m
$ gcloud kms inventory search\-protected\-resources \-\-keyname=puppy \e
    \-\-scope=1234
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-scope\fR=\fIORGANIZATION_ID\fR

Organization ID.

.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-keyname\fR on the command line with a fully
specified name;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fB\-\-keyname\fR=\fIKEYNAME\fR

ID of the key or fully qualified identifier for the key.

To set the \f5key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-keyname\fR on the command line.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-keyring\fR=\fIKEYRING\fR

The KMS keyring of the key.

To set the \f5keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-keyname\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The Google Cloud location for the key.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-keyname\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-resource\-types\fR=[\fIRESOURCE_TYPES\fR,...]

A list of resource types that this request searches for. If empty, it will
search all the trackable resource types
(https://cloud.google.com/kms/docs/view\-key\-usage#tracked\-resource\-types).

Regular expressions are also supported. For example:

.RS 2m
.IP "\(em" 2m
\f5\fIcompute.googleapis.com.*\fR\fR snapshots resources whose type starts with
\f5\fIcompute.googleapis.com\fR\fR.
.IP "\(em" 2m
\f5\fI.*Image\fR\fR snapshots resources whose type ends with \f5\fIImage\fR\fR.
.IP "\(em" 2m
\f5\fI.*Image.*\fR\fR snapshots resources whose type contains \f5\fIImage\fR\fR.
.RE
.sp

See RE2 (https://github.com/google/re2/wiki/Syntax) for all supported regular
expression syntax. If the regular expression does not match any supported
resource type, an \f5\fIINVALID_ARGUMENT\fR\fR error will be returned.


.RE
.sp

.SH "LIST COMMAND FLAGS"

.RS 2m
.TP 2m
\fB\-\-filter\fR=\fIEXPRESSION\fR

Apply a Boolean filter \fIEXPRESSION\fR to each resource item to be listed. If
the expression evaluates \f5True\fR, 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: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-limit\fR=\fILIMIT\fR

Maximum number of resources to list. The default is \fBunlimited\fR. This flag
interacts with other flags that are applied in this order: \fB\-\-flatten\fR,
\fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-page\-size\fR=\fIPAGE_SIZE\fR

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 \fBunlimited\fR (no paging). Paging may
be applied before or after \fB\-\-filter\fR and \fB\-\-limit\fR depending on the
service.

.TP 2m
\fB\-\-sort\-by\fR=[\fIFIELD\fR,...]

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:
\fB\-\-flatten\fR, \fB\-\-sort\-by\fR, \fB\-\-filter\fR, \fB\-\-limit\fR.

.TP 2m
\fB\-\-uri\fR

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 \fB\-\-format\fR,
the formatting is applied on this URI list. To display URIs alongside other keys
instead, use the \fBuri()\fR transform.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha kms inventory search\-protected\-resources
.RE

.RS 2m
$ gcloud beta kms inventory search\-protected\-resources
.RE