Skip to main content

addons_config

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

Overview

Nameaddons_config
TypeResource
Idgoogle.apigee.addons_config

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
advancedApiOpsConfigobjectConfiguration for the Advanced API Ops add-on. (id: GoogleCloudApigeeV1AdvancedApiOpsConfig)
analyticsConfigobjectConfiguration for the Analytics add-on. Only used in organizations.environments.addonsConfig. (id: GoogleCloudApigeeV1AnalyticsConfig)
apiSecurityConfigobjectConfiguration for the API Security add-on. (id: GoogleCloudApigeeV1ApiSecurityConfig)
connectorsPlatformConfigobjectConfiguration for the Connectors Platform add-on. (id: GoogleCloudApigeeV1ConnectorsPlatformConfig)
integrationConfigobjectConfiguration for the Integration add-on. (id: GoogleCloudApigeeV1IntegrationConfig)
monetizationConfigobjectConfiguration for the Monetization add-on. (id: GoogleCloudApigeeV1MonetizationConfig)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_environments_get_addons_configselectorganizationsId, environmentsIdGets the add-ons config of an environment.
organizations_environments_addons_config_set_addon_enablementexecorganizationsId, environmentsIdUpdates an add-on enablement status of 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.

NameDatatypeDescription
environmentsIdstring
organizationsIdstring

SELECT examples

Gets the add-ons config of an environment.

SELECT
advancedApiOpsConfig,
analyticsConfig,
apiSecurityConfig,
connectorsPlatformConfig,
integrationConfig,
monetizationConfig
FROM google.apigee.addons_config
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

Lifecycle Methods

Updates an add-on enablement status of an environment.

EXEC google.apigee.addons_config.organizations_environments_addons_config_set_addon_enablement 
@organizationsId='{{ organizationsId }}' --required,
@environmentsId='{{ environmentsId }}' --required
@@json=
'{
"analyticsEnabled": {{ analyticsEnabled }},
"apiSecurityEnabled": {{ apiSecurityEnabled }}
}';