1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 18:45:13 +00:00
gcloud-help/gcloud/alpha/services/api-keys/describe
2023-05-04 10:43:54 +00:00

76 lines
2.6 KiB
Text

NAME
gcloud alpha services api-keys describe - describe an API key's metadata
SYNOPSIS
gcloud alpha services api-keys describe (KEY : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe an API key's metadata.
EXAMPLES
To describe an API key using Key:
$ gcloud alpha services api-keys describe 1234 OR
$ gcloud alpha services api-keys describe \
projects/myproject/locations/global/keys/1234
To describe an API key with key and project:
$ gcloud alpha services api-keys describe 1234 --project=myproject
To describe an API key with key, project, and location:
$ gcloud alpha services api-keys describe 1234 --project=myproject \
--location=global
POSITIONAL ARGUMENTS
Key resource - The name of the key to describe. 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 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
ID of the key or fully qualified identifier for the key.
To set the key attribute:
▸ provide the argument key on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Location of the key.
To set the location attribute:
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ location will default to global.
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.
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:
$ gcloud services api-keys describe
$ gcloud beta services api-keys describe