gcloud alpha edge-cloud api-keys create

NAME
gcloud alpha edge-cloud api-keys create - create a Google Distributed Cloud API key
SYNOPSIS
gcloud alpha edge-cloud api-keys create (API_KEY : --location=LOCATION) --service-account-name=SERVICE_ACCOUNT_NAME --zone=ZONE [--api-target=[KEY=VALUE,…]] [--async] [--validity=VALIDITY] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Creates a Google Distributed Cloud API key.
EXAMPLES
To create a service-account-bound API key in a specific Google Distributed Cloud zone
that is valid for two hours and restricted to specific API methods, run:
gcloud alpha edge-cloud api-keys create my-api-key --location=us-central1 --project=my-project --zone=us-central1-edge-zone1 --service-account-name=projects/my-project/locations/us-central1/serviceAccounts/my-sa --validity=7200s --api-target service="compute.test-api.com",methods="*" --api-target service="storage.test-api.com",methods="GET|LIST"
POSITIONAL ARGUMENTS
ApiKey resource - The API key to be created. 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 api_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.

API_KEY
ID of the apiKey or fully qualified identifier for the apiKey.

To set the api_key attribute:

  • provide the argument api_key on the command line.

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

--location=LOCATION
The location name.

To set the location attribute:

  • provide the argument api_key on the command line with a fully specified name;
  • provide the argument --location on the command line.
REQUIRED FLAGS
--service-account-name=SERVICE_ACCOUNT_NAME
The name of the service account to bind the API key to.
--zone=ZONE
The Google Distributed Cloud zone ID where the API key will be created.
OPTIONAL FLAGS
--api-target=[KEY=VALUE,…]
API target restriction. Can be specified multiple times. Each instance is a comma-separated list of key=value pairs.
  • Required keys: 'service'.
  • Optional keys: 'methods'. 'methods' should be a pipe-separated string. Omit the 'methods' key to allow all methods.

Examples:

  • --api-target service="compute.test-api.com",methods="*"
  • --api-target service="storage.test-api.com",methods="GET|LIST"
  • --api-target service="pubsub.test-api.com"
--async
Return immediately, without waiting for the operation in progress to complete.
--validity=VALIDITY
The validity duration for the key (e.g., 3600s, 1h, 1d). Default and maximum allowed is 366d.
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 edgecontainer/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/edge-cloud
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.