- NAME
-
- gcloud api-gateway api-configs create - add a new config to an API
- SYNOPSIS
-
-
gcloud 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
-
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 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.
-
provide the argument
--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.
-
provide the argument
-
provide the argument
-
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.
- 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.
-
Configuration files for the API.
- 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
-
These variants are also available:
gcloud alpha api-gateway api-configs create
gcloud beta api-gateway api-configs create
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 2024-02-06 UTC.