mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
110 lines
3.9 KiB
Text
110 lines
3.9 KiB
Text
NAME
|
|
gcloud alpha api-gateway api-configs create - add a new config to an API
|
|
|
|
SYNOPSIS
|
|
gcloud alpha api-gateway api-configs create (API_CONFIG : --api=API)
|
|
(--grpc-files=[FILE,...] | --openapi-spec=[FILE,...]) [--async]
|
|
[--backend-auth-service-account=BACKEND_AUTH_SERVICE_ACCOUNT]
|
|
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
|
|
[GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) Add a new config to an API.
|
|
|
|
NOTE: If the specified API does not exist it will be created.
|
|
|
|
EXAMPLES
|
|
To create an API config for the API 'my-api' with an OpenAPI spec, run:
|
|
|
|
$ gcloud alpha api-gateway api-configs create my-config \
|
|
--api=my-api --openapi-spec=path/to/openapi_spec.yaml
|
|
|
|
POSITIONAL ARGUMENTS
|
|
Api config resource - Name for API Config which will 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_config on the command line with a fully
|
|
specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
To set the location attribute:
|
|
◆ provide the argument api_config on the command line with a fully
|
|
specified name;
|
|
◆ Location for API and API Configs. Defaults to global.
|
|
|
|
This must be specified.
|
|
|
|
API_CONFIG
|
|
ID of the api-config or fully qualified identifier for the
|
|
api-config.
|
|
|
|
To set the api-config attribute:
|
|
▸ provide the argument api_config on the command line.
|
|
|
|
This positional argument must be specified if any of the other
|
|
arguments in this group are specified.
|
|
|
|
--api=API
|
|
API ID.
|
|
|
|
To set the api attribute:
|
|
▸ provide the argument api_config on the command line with a fully
|
|
specified name;
|
|
▸ provide the argument --api on the command line.
|
|
|
|
REQUIRED FLAGS
|
|
Configuration files for the API.
|
|
|
|
Exactly one of these must be specified:
|
|
|
|
--grpc-files=[FILE,...]
|
|
Files describing the GRPC service. Google Service Configuration files
|
|
in JSON or YAML formats as well as Proto descriptors should be
|
|
listed.
|
|
|
|
--openapi-spec=[FILE,...]
|
|
The OpenAPI v2 specifications containing service configuration
|
|
information, and API specification for the gateway.
|
|
|
|
OPTIONAL FLAGS
|
|
--async
|
|
Return immediately, without waiting for the operation in progress to
|
|
complete.
|
|
|
|
--backend-auth-service-account=BACKEND_AUTH_SERVICE_ACCOUNT
|
|
Service account which will be used to sign tokens for backends with
|
|
authentication configured.
|
|
|
|
--display-name=DISPLAY_NAME
|
|
Human readable name which can optionally be supplied.
|
|
|
|
--labels=[KEY=VALUE,...]
|
|
List of label KEY=VALUE pairs to add.
|
|
|
|
Keys must start with a lowercase character and contain only hyphens
|
|
(-), underscores (_), lowercase characters, and numbers. Values must
|
|
contain only hyphens (-), underscores (_), lowercase characters, and
|
|
numbers.
|
|
|
|
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 api-gateway api-configs create
|
|
|
|
$ gcloud beta api-gateway api-configs create
|
|
|