environment_config

Creates, updates, deletes, gets or lists an environment_config resource.

Overview

Name	environment_config
Type	Resource
Id	google.apigee.environment_config

Fields

The following fields are returned by SELECT queries:

organizations_environments_get_deployed_config

Successful response

Name	Datatype	Description
name	string	Name of the environment configuration in the following format: organizations/{org}/environments/{env}/configs/{config}
addonsConfig	object	The latest runtime configurations for add-ons. (id: GoogleCloudApigeeV1RuntimeAddonsConfig)
arcConfigLocation	string	The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.
clientIpResolutionConfig	object	The algorithm to resolve IP. (id: GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig)
createTime	string (google-datetime)	Time that the environment configuration was created.
dataCollectors	array	List of data collectors used by the deployments in the environment.
debugMask	object	Debug mask that applies to all deployments in the environment. (id: GoogleCloudApigeeV1DebugMask)
deploymentGroups	array	List of deployment groups in the environment.
deployments	array	List of deployments in the environment.
envScopedRevisionId	string (int64)	Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes.
featureFlags	object	Feature flags inherited from the organization and environment.
flowhooks	array	List of flow hooks in the environment.
forwardProxyUri	string	The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways.
gatewayConfigLocation	string	The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.
keystores	array	List of keystores in the environment.
provider	string	Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging.
pubsubTopic	string	Name of the PubSub topic for the environment.
resourceReferences	array	List of resource references in the environment.
resources	array	List of resource versions in the environment.
revisionId	string (int64)	Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed.
sequenceNumber	string (int64)	DEPRECATED: Use revision_id.
targets	array	List of target servers in the environment. Disabled target servers are not displayed.
traceConfig	object	Trace configurations. Contains config for the environment and config overrides for specific API proxies. (id: GoogleCloudApigeeV1RuntimeTraceConfig)
uid	string	Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_get_deployed_config	select	organizationsId, environmentsId		Gets the deployed configuration for an environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentsId	string
organizationsId	string

SELECT examples

organizations_environments_get_deployed_config

Gets the deployed configuration for an environment.

SELECT
name,
addonsConfig,
arcConfigLocation,
clientIpResolutionConfig,
createTime,
dataCollectors,
debugMask,
deploymentGroups,
deployments,
envScopedRevisionId,
featureFlags,
flowhooks,
forwardProxyUri,
gatewayConfigLocation,
keystores,
provider,
pubsubTopic,
resourceReferences,
resources,
revisionId,
sequenceNumber,
targets,
traceConfig,
uid
FROM google.apigee.environment_config
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;