File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_kms_key-handles_describe.1
.TH "GCLOUD_ALPHA_KMS_KEY\-HANDLES_DESCRIBE" 1
.SH "NAME"
.HP
gcloud alpha kms key\-handles describe \- get metadata for a KeyHandle
.SH "SYNOPSIS"
.HP
\f5gcloud alpha kms key\-handles describe\fR (\fIKEY_HANDLE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Get metadata for a KeyHandle.
.SH "EXAMPLES"
The following command gets metadata for a KeyHandle named \f5my\-key\-handle\fR
in the locations \f5us\-central1\fR.
.RS 2m
$ gcloud alpha kms key\-handles describe my\-key\-handle \e
\-\-location=us\-central1
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Key handle resource \- The KeyHandle to get metadata for. 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 \f5key_handle\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fIKEY_HANDLE\fR
ID of the key handle or fully qualified identifier for the key handle.
To set the \f5key_handle\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5key_handle\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
The location of the resource.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5key_handle\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 "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 "API REFERENCE"
This command uses the \fBcloudkms/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/kms/
.SH "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:
.RS 2m
$ gcloud kms key\-handles describe
.RE
.RS 2m
$ gcloud beta kms key\-handles describe
.RE