gcloud kms key-handles describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud kms key-handles describe - get metadata for a KeyHandle
- SYNOPSIS
gcloud kms key-handles describe(KEY_HANDLE:--location=LOCATION)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Get metadata for a KeyHandle.
- EXAMPLES
- The following command gets metadata for a KeyHandle named
my-key-handlein the locationsus-central1.gcloudkmskey-handlesdescribemy-key-handle--location=us-central1 - POSITIONAL ARGUMENTS
- Key handle resource - The KeyHandle to get metadata for. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
key_handleon the command line with a fullyspecified name; - provide the argument
--projecton 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_handleattribute:- provide the argument
key_handleon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The location of the resource.
To set the
locationattribute:- provide the argument
key_handleon the command line with a fullyspecified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Key handle resource - The KeyHandle to get metadata for. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes 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 helpfor details. - API REFERENCE
- This command uses the
cloudkms/v1API. The full documentation forthis API can be found at:https://cloud.google.com/kms/ - NOTES
- These variants are also available:
gcloudalphakmskey-handlesdescribegcloudbetakmskey-handlesdescribe
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.