Creates an Apigee organization. See Create an Apigee organization.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations create ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudApigeeV1Organization:
  addons-config:
    advanced-api-ops-config:
      enabled: boolean
    analytics-config:
      enabled: boolean
      expire-time-millis: string
      state: string
      update-time: string
    api-security-config:
      enabled: boolean
      expires-at: string
    connectors-platform-config:
      enabled: boolean
      expires-at: string
    integration-config:
      enabled: boolean
    monetization-config:
      enabled: boolean
  analytics-region: string
  api-consumer-data-encryption-key-name: string
  api-consumer-data-location: string
  apigee-project-id: string
  attributes: [string]
  authorized-network: string
  billing-type: string
  ca-certificate: string
  control-plane-encryption-key-name: string
  created-at: string
  customer-name: string
  description: string
  disable-vpc-peering: boolean
  display-name: string
  environments: [string]
  expires-at: string
  last-modified-at: string
  name: string
  portal-disabled: boolean
  project-id: string
  runtime-database-encryption-key-name: string
  runtime-type: string
  state: string
  subscription-plan: string
  subscription-type: string
  type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .addons-config.advanced-api-ops-config enabled=true

    • Flag that specifies whether the Advanced API Ops add-on is enabled.

  • ..analytics-config enabled=true

    • Whether the Analytics add-on is enabled.
  • expire-time-millis=dolor
    • Output only. Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.
  • state=aliquyam
    • Output only. The state of the Analytics add-on.

  • update-time=no

    • Output only. The latest update time.

  • ..api-security-config enabled=true

    • Flag that specifies whether the API security add-on is enabled.

  • expires-at=lorem

    • Output only. Time at which the API Security add-on expires in in milliseconds since epoch. If unspecified, the add-on will never expire.

  • ..connectors-platform-config enabled=false

    • Flag that specifies whether the Connectors Platform add-on is enabled.

  • expires-at=gubergren

    • Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.

  • ..integration-config enabled=true

    • Flag that specifies whether the Integration add-on is enabled.

  • ..monetization-config enabled=true

    • Flag that specifies whether the Monetization add-on is enabled.

  • ... analytics-region=duo

    • 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.
  • api-consumer-data-encryption-key-name=sit
    • Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType is EVALUATION or the region is not US/EU, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
  • api-consumer-data-location=magna
    • This field is needed only for customers with control plane in US or EU. 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.
  • apigee-project-id=et
    • 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=rebum.
    • Not used by Apigee.
    • Each invocation of this argument appends the given value to the array.
  • authorized-network=dolor
    • 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.
  • billing-type=lorem
  • ca-certificate=justo
    • Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
  • control-plane-encryption-key-name=amet.
    • Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
  • created-at=no
    • Output only. Time that the Apigee organization was created in milliseconds since epoch.
  • customer-name=nonumy
    • Not used by Apigee.
  • description=sed
    • Description of the Apigee organization.
  • disable-vpc-peering=false
    • 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.
  • display-name=sanctus
    • Display name for the Apigee organization. Unused, but reserved for future use.
  • environments=nonumy
    • Output only. List of environments in the Apigee organization.
    • Each invocation of this argument appends the given value to the array.
  • expires-at=rebum.
    • Output only. Time that the Apigee organization is scheduled for deletion.
  • last-modified-at=tempor
    • Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
  • name=dolore
    • Output only. Name of the Apigee organization.
  • portal-disabled=true
    • Configuration for the Portals settings.
  • project-id=dolore
    • Output only. Project ID associated with the Apigee organization.
  • runtime-database-encryption-key-name=amet
    • 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. Required when RuntimeType is CLOUD. If not specified when 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.
  • runtime-type=ut
    • Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
  • state=at
    • Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use.
  • subscription-plan=sit
    • Output only. Subscription plan that the customer has purchased. Output only.
  • subscription-type=vero
    • 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=duo
    • Not used by Apigee.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p parent=string
    • Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").