organizations

Creates, updates, deletes, gets or lists a organizations resource.

Overview

Name	organizations
Type	Resource
Id	google.apigee.organizations

Fields

Name	Datatype	Description
name	string	Output only. Name of the Apigee organization.
description	string	Description of the Apigee organization.
addonsConfig	object	Add-on configurations for the Apigee organization.
analyticsRegion	string	Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization.
apiConsumerDataEncryptionKeyName	string	Cloud KMS key name used for encrypting API consumer data. If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
apiConsumerDataLocation	string	This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.
apigeeProjectId	string	Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee.
attributes	array	Not used by Apigee.
authorizedNetwork	string	Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork Note: Not supported for Apigee hybrid.
billingType	string	Billing type of the Apigee organization. See Apigee pricing.
caCertificate	string	Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
controlPlaneEncryptionKeyName	string	Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU". If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
createdAt	string	Output only. Time that the Apigee organization was created in milliseconds since epoch.
customerName	string	Not used by Apigee.
disableVpcPeering	boolean	Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.
displayName	string	Display name for the Apigee organization. Unused, but reserved for future use.
environments	array	Output only. List of environments in the Apigee organization.
expiresAt	string	Output only. Time that the Apigee organization is scheduled for deletion.
lastModifiedAt	string	Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
portalDisabled	boolean	Configuration for the Portals settings.
projectId	string	Output only. Project ID associated with the Apigee organization.
properties	object	Message for compatibility with legacy Edge specification for Java Properties object in JSON.
runtimeDatabaseEncryptionKeyName	string	Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
runtimeType	string	Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
state	string	Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use.
subscriptionPlan	string	Output only. Subscription plan that the customer has purchased. Output only.
subscriptionType	string	Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See Apigee pricing.
type	string	Not used by Apigee.

Methods

Name	Accessible by	Required Params	Description
organizations_get	SELECT	organizationsId	Gets the profile for an Apigee organization. See Understanding organizations.
organizations_list	SELECT		Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.
organizations_create	INSERT		Creates an Apigee organization. See Create an Apigee organization.
organizations_delete	DELETE	organizationsId	Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the retention field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to MINIMUM.
organizations_update	REPLACE	organizationsId	Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
organizations_set_addons	EXEC	organizationsId	Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.
organizations_set_sync_authorization	EXEC	organizationsId	Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

SELECT examples

Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.

SELECT
name,
description,
addonsConfig,
analyticsRegion,
apiConsumerDataEncryptionKeyName,
apiConsumerDataLocation,
apigeeProjectId,
attributes,
authorizedNetwork,
billingType,
caCertificate,
controlPlaneEncryptionKeyName,
createdAt,
customerName,
disableVpcPeering,
displayName,
environments,
expiresAt,
lastModifiedAt,
portalDisabled,
projectId,
properties,
runtimeDatabaseEncryptionKeyName,
runtimeType,
state,
subscriptionPlan,
subscriptionType,
type
FROM google.apigee.organizations
;

INSERT example

Use the following StackQL query and manifest file to create a new organizations resource.

All Properties

/*+ create */
INSERT INTO google.apigee.organizations (
customerName,
type,
apiConsumerDataLocation,
disableVpcPeering,
description,
displayName,
analyticsRegion,
properties,
attributes,
runtimeType,
apiConsumerDataEncryptionKeyName,
authorizedNetwork,
addonsConfig,
controlPlaneEncryptionKeyName,
portalDisabled,
billingType,
runtimeDatabaseEncryptionKeyName
)
SELECT 
'{{ customerName }}',
'{{ type }}',
'{{ apiConsumerDataLocation }}',
{{ disableVpcPeering }},
'{{ description }}',
'{{ displayName }}',
'{{ analyticsRegion }}',
'{{ properties }}',
'{{ attributes }}',
'{{ runtimeType }}',
'{{ apiConsumerDataEncryptionKeyName }}',
'{{ authorizedNetwork }}',
'{{ addonsConfig }}',
'{{ controlPlaneEncryptionKeyName }}',
{{ portalDisabled }},
'{{ billingType }}',
'{{ runtimeDatabaseEncryptionKeyName }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: subscriptionType
      value: string
    - name: name
      value: string
    - name: customerName
      value: string
    - name: type
      value: string
    - name: lastModifiedAt
      value: string
    - name: apiConsumerDataLocation
      value: string
    - name: disableVpcPeering
      value: boolean
    - name: description
      value: string
    - name: displayName
      value: string
    - name: analyticsRegion
      value: string
    - name: properties
      value:
        - name: property
          value:
            - - name: name
                value: string
              - name: value
                value: string
    - name: attributes
      value:
        - string
    - name: runtimeType
      value: string
    - name: apigeeProjectId
      value: string
    - name: apiConsumerDataEncryptionKeyName
      value: string
    - name: subscriptionPlan
      value: string
    - name: projectId
      value: string
    - name: authorizedNetwork
      value: string
    - name: addonsConfig
      value:
        - name: advancedApiOpsConfig
          value:
            - name: enabled
              value: boolean
        - name: connectorsPlatformConfig
          value:
            - name: enabled
              value: boolean
            - name: expiresAt
              value: string
        - name: apiSecurityConfig
          value:
            - name: enabled
              value: boolean
            - name: expiresAt
              value: string
        - name: monetizationConfig
          value:
            - name: enabled
              value: boolean
        - name: integrationConfig
          value:
            - name: enabled
              value: boolean
        - name: analyticsConfig
          value:
            - name: updateTime
              value: string
            - name: enabled
              value: boolean
            - name: expireTimeMillis
              value: string
            - name: state
              value: string
    - name: controlPlaneEncryptionKeyName
      value: string
    - name: caCertificate
      value: string
    - name: environments
      value:
        - string
    - name: portalDisabled
      value: boolean
    - name: billingType
      value: string
    - name: state
      value: string
    - name: expiresAt
      value: string
    - name: createdAt
      value: string
    - name: runtimeDatabaseEncryptionKeyName
      value: string

REPLACE example

Replaces all fields in the specified organizations resource.

/*+ update */
REPLACE google.apigee.organizations
SET 
customerName = '{{ customerName }}',
type = '{{ type }}',
apiConsumerDataLocation = '{{ apiConsumerDataLocation }}',
disableVpcPeering = true|false,
description = '{{ description }}',
displayName = '{{ displayName }}',
analyticsRegion = '{{ analyticsRegion }}',
properties = '{{ properties }}',
attributes = '{{ attributes }}',
runtimeType = '{{ runtimeType }}',
apiConsumerDataEncryptionKeyName = '{{ apiConsumerDataEncryptionKeyName }}',
authorizedNetwork = '{{ authorizedNetwork }}',
addonsConfig = '{{ addonsConfig }}',
controlPlaneEncryptionKeyName = '{{ controlPlaneEncryptionKeyName }}',
portalDisabled = true|false,
billingType = '{{ billingType }}',
runtimeDatabaseEncryptionKeyName = '{{ runtimeDatabaseEncryptionKeyName }}'
WHERE 
organizationsId = '{{ organizationsId }}';

DELETE example

Deletes the specified organizations resource.

/*+ delete */
DELETE FROM google.apigee.organizations
WHERE organizationsId = '{{ organizationsId }}';