mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-22 15:52:30 +00:00
gcloud: Thu Mar 26 12:11:21 UTC 2026
This commit is contained in:
Automated
parent
c0febd2be1
commit
89a3bc9276
1093 changed files with 69108 additions and 2686 deletions
171
gcloud/apihub/addons/manage-config
Normal file
171
gcloud/apihub/addons/manage-config
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
NAME
|
||||
gcloud apihub addons manage-config - manage the Config of an Addon
|
||||
|
||||
SYNOPSIS
|
||||
gcloud apihub addons manage-config (ADDON : --location=LOCATION) [--async]
|
||||
[--[no-]all-data-addon-config-enabled
|
||||
| --gateway-plugin-addon-config-configs=[apigeeEdgeConfig=APIGEEEDGECONFIG],
|
||||
[apigeeOpdkConfig=APIGEEOPDKCONFIG],
|
||||
[apigeeXHybridConfig=APIGEEXHYBRIDCONFIG],
|
||||
[pluginInstance=PLUGININSTANCE]] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Manage the config of an addon
|
||||
|
||||
EXAMPLES
|
||||
To manage the config of an addon with the ID system-advanced-api-security,
|
||||
run:
|
||||
|
||||
$ gcloud apihub addons manage-config system-advanced-api-security \
|
||||
--gateway-plugin-addon-config-configs="pluginInstance=projects/m\
|
||||
y-project/locations/us-central1/plugins/system-apigee-x-and-hybrid/i\
|
||||
nstances/my-instance-1,apigeeXHybridConfig={environmentFilter={allEn\
|
||||
vironments=true}}" \
|
||||
--gateway-plugin-addon-config-configs="pluginInstance=projects/m\
|
||||
y-project/locations/us-central1/plugins/system-edge-public-cloud/ins\
|
||||
tances/my-instance-2,apigeeEdgeConfig={environmentFilter={environmen\
|
||||
ts=['env1']}}" --project=my-project --location=us-central1
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Addon resource - The name of the addon for which the config is to be
|
||||
managed. Format: projects/{project}/locations/{location}/addons/{addon}.
|
||||
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 addon 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.
|
||||
|
||||
ADDON
|
||||
ID of the addon or fully qualified identifier for the addon.
|
||||
|
||||
To set the addon attribute:
|
||||
▸ provide the argument addon 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 id of the addon resource.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument addon on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
Arguments for the config.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
Configuration for addons which act on all data in the API hub. This is
|
||||
used to specify if the addon is enabled for all data in the API hub.
|
||||
|
||||
--[no-]all-data-addon-config-enabled
|
||||
If true, the addon is enabled for all data in the API hub. Use
|
||||
--all-data-addon-config-enabled to enable and
|
||||
--no-all-data-addon-config-enabled to disable.
|
||||
|
||||
Configuration for gateway plugin addons. This is used to specify the
|
||||
list of gateway plugin configs for which the addon is enabled.
|
||||
|
||||
--gateway-plugin-addon-config-configs=[apigeeEdgeConfig=APIGEEEDGECONFIG],[apigeeOpdkConfig=APIGEEOPDKCONFIG],[apigeeXHybridConfig=APIGEEXHYBRIDCONFIG],[pluginInstance=PLUGININSTANCE]
|
||||
Required, The list of gateway plugin configs for which the addon is
|
||||
enabled. Each gateway plugin config should have a unique plugin
|
||||
instance.
|
||||
|
||||
apigeeEdgeConfig
|
||||
Configuration for Apigee Edge gateways.
|
||||
|
||||
environmentFilter
|
||||
The filter to apply on the resources managed by the gateway
|
||||
plugin instance. If provided this filter applies environment
|
||||
specific filtering.
|
||||
|
||||
allEnvironments
|
||||
Indicates if this filter should match all environments or
|
||||
only a subset of environments. If set to true, all
|
||||
environments are matched.
|
||||
|
||||
environments
|
||||
If provided, only environments in this list are matched.
|
||||
This field is ignored if all_environments is true.
|
||||
|
||||
apigeeOpdkConfig
|
||||
Configuration for Apigee OPDK gateways.
|
||||
|
||||
environmentFilter
|
||||
The filter to apply on the resources managed by the gateway
|
||||
plugin instance. If provided this filter applies environment
|
||||
specific filtering.
|
||||
|
||||
allEnvironments
|
||||
Indicates if this filter should match all environments or
|
||||
only a subset of environments. If set to true, all
|
||||
environments are matched.
|
||||
|
||||
environments
|
||||
If provided, only environments in this list are matched.
|
||||
This field is ignored if all_environments is true.
|
||||
|
||||
apigeeXHybridConfig
|
||||
Configuration for Apigee X and Apigee Hybrid gateways.
|
||||
|
||||
environmentFilter
|
||||
The filter to apply on the resources managed by the gateway
|
||||
plugin instance. If provided this filter applies environment
|
||||
specific filtering.
|
||||
|
||||
allEnvironments
|
||||
Indicates if this filter should match all environments or
|
||||
only a subset of environments. If set to true, all
|
||||
environments are matched.
|
||||
|
||||
environments
|
||||
If provided, only environments in this list are matched.
|
||||
This field is ignored if all_environments is true.
|
||||
|
||||
pluginInstance
|
||||
The name of the gateway plugin instance for which the config is
|
||||
to be specified. Format:
|
||||
projects/{project}/locations/{location}/plugins/{plugin}/pluginInstances/{plugin_instance}.
|
||||
|
||||
Shorthand Example:
|
||||
|
||||
--gateway-plugin-addon-config-configs=apigeeEdgeConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},apigeeOpdkConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},apigeeXHybridConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},pluginInstance=string --gateway-plugin-addon-config-configs=apigeeEdgeConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},apigeeOpdkConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},apigeeXHybridConfig={environmentFilter={allEnvironments=boolean,environments=[string]}},pluginInstance=string
|
||||
|
||||
JSON Example:
|
||||
|
||||
--gateway-plugin-addon-config-configs='[{"apigeeEdgeConfig": {"environmentFilter": {"allEnvironments": boolean, "environments": ["string"]}}, "apigeeOpdkConfig": {"environmentFilter": {"allEnvironments": boolean, "environments": ["string"]}}, "apigeeXHybridConfig": {"environmentFilter": {"allEnvironments": boolean, "environments": ["string"]}}, "pluginInstance": "string"}]'
|
||||
|
||||
File Example:
|
||||
|
||||
--gateway-plugin-addon-config-configs=path_to_file.(yaml|json)
|
||||
|
||||
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 apihub/v1 API. The full documentation for this API
|
||||
can be found at:
|
||||
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
|
||||
|
||||
NOTES
|
||||
This variant is also available:
|
||||
|
||||
$ gcloud alpha apihub addons manage-config
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue