- NAME
-
- gcloud alpha kms key-handles describe - get metadata for a key handle
- SYNOPSIS
-
-
gcloud alpha kms key-handles describe
(KEY_HANDLE
:--location
=LOCATION
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Get metadata for a key handle. - EXAMPLES
-
The following command gets metadata for a key handle named
my-key-handle
in the locationsus-central1
.gcloud alpha kms key-handles describe my-key-handle --location=us-central1
- POSITIONAL ARGUMENTS
-
-
Key handle resource - The key handle 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
project
attribute:-
provide the argument
key_handle
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
KEY_HANDLE
-
ID of the key handle or fully qualified identifier for the key handle.
To set the
key_handle
attribute:-
provide the argument
key_handle
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location
=LOCATION
-
The location of the resource.
To set the
location
attribute:-
provide the argument
key_handle
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
-
provide the argument
-
Key handle resource - The key handle 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.
- 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. - API REFERENCE
-
This command uses the
cloudkms/v1
API. The full documentation for this API can be found at: https://cloud.google.com/kms/ - 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.
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 2025-01-22 UTC.