control_plane_access
Creates, updates, deletes, gets or lists a control_plane_access resource.
Overview
| Name | control_plane_access |
| Type | Resource |
| Id | google.apigee.control_plane_access |
Fields
The following fields are returned by SELECT queries:
- organizations_get_control_plane_access
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. The resource name of the ControlPlaneAccess. Format: "organizations/{org}/controlPlaneAccess" |
analyticsPublisherIdentities | array | Optional. Array of service accounts authorized to publish analytics data to the control plane (for the Message Processor component). |
synchronizerIdentities | array | Optional. Array of service accounts to grant access to control plane resources (for the Synchronizer component). The service accounts must have Apigee Synchronizer Manager role. See also Create service accounts. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
organizations_get_control_plane_access | select | organizationsId | Lists the service accounts allowed to access Apigee control plane directly for limited functionality. Note: Available to Apigee hybrid only. | |
organizations_update_control_plane_access | update | organizationsId | updateMask | Updates the permissions required to allow Apigee runtime-plane components access to the control plane. Currently, the permissions required are to: 1. Allow runtime components to publish analytics data to the control plane. Note: Available to Apigee hybrid only. |
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 |
|---|---|---|
organizationsId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- organizations_get_control_plane_access
Lists the service accounts allowed to access Apigee control plane directly for limited functionality. Note: Available to Apigee hybrid only.
SELECT
name,
analyticsPublisherIdentities,
synchronizerIdentities
FROM google.apigee.control_plane_access
WHERE organizationsId = '{{ organizationsId }}' -- required;
UPDATE examples
- organizations_update_control_plane_access
Updates the permissions required to allow Apigee runtime-plane components access to the control plane. Currently, the permissions required are to: 1. Allow runtime components to publish analytics data to the control plane. Note: Available to Apigee hybrid only.
UPDATE google.apigee.control_plane_access
SET
data__name = '{{ name }}',
data__synchronizerIdentities = '{{ synchronizerIdentities }}',
data__analyticsPublisherIdentities = '{{ analyticsPublisherIdentities }}'
WHERE
organizationsId = '{{ organizationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;