apim_service_extensions

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

Overview

Name	`apim_service_extensions`
Type	Resource
Id	`google.apigee.apim_service_extensions`

Fields

The following fields are returned by SELECT queries:

organizations_apim_service_extensions_get
organizations_apim_service_extensions_list

Name	Datatype	Description
`name`	`string`	Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
`createTime`	`string (google-datetime)`	Output only. The time that this resource was created on the server.
`extensionProcessor`	`string`	Required. Name of the proxy deployed in the Apigee X instance.
`extensions`	`array`	Optional. List of extensions that are part of the service extension. Refer to https://cloud.google.com/service-extensions/docs/quotas#limits for any limits.
`lbForwardingRule`	`string`	Required. Name of the Google Cloud LB forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} projects/{project}/global/forwardingRules/{forwarding_rule}
`network`	`string`	Required. The network where the forwarding rule is created. Format: projects/{project}/global/networks/{network}
`networkConfigs`	`array`	Required. List of network configurations for the APIM service extension.
`state`	`string`	Output only. State of the APIM service extension. Values other than `ACTIVE` mean the resource is not ready to use. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, UPDATING)
`updateTime`	`string (google-datetime)`	Output only. The time that this resource was updated on the server.

Name	Datatype	Description
`name`	`string`	Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
`createTime`	`string (google-datetime)`	Output only. The time that this resource was created on the server.
`extensionProcessor`	`string`	Required. Name of the proxy deployed in the Apigee X instance.
`extensions`	`array`	Optional. List of extensions that are part of the service extension. Refer to https://cloud.google.com/service-extensions/docs/quotas#limits for any limits.
`lbForwardingRule`	`string`	Required. Name of the Google Cloud LB forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} projects/{project}/global/forwardingRules/{forwarding_rule}
`network`	`string`	Required. The network where the forwarding rule is created. Format: projects/{project}/global/networks/{network}
`networkConfigs`	`array`	Required. List of network configurations for the APIM service extension.
`state`	`string`	Output only. State of the APIM service extension. Values other than `ACTIVE` mean the resource is not ready to use. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING, UPDATING)
`updateTime`	`string (google-datetime)`	Output only. The time that this resource was updated on the server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`organizations_apim_service_extensions_get`	`select`	`organizationsId`, `apimServiceExtensionsId`		Gets APIM service extension details.
`organizations_apim_service_extensions_list`	`select`	`organizationsId`	`pageSize`, `pageToken`	Lists all APIM service extensions in an organization.
`organizations_apim_service_extensions_create`	`insert`	`organizationsId`	`apimServiceExtensionId`	Creates an APIM ServiceExtension in an organization.
`organizations_apim_service_extensions_patch`	`update`	`organizationsId`, `apimServiceExtensionsId`	`allowMissing`, `updateMask`	Updates an APIM service extension in an organization.
`organizations_apim_service_extensions_delete`	`delete`	`organizationsId`, `apimServiceExtensionsId`		Deletes APIM service extension from an organization.

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
`apimServiceExtensionsId`	`string`
`organizationsId`	`string`
`allowMissing`	`boolean`
`apimServiceExtensionId`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

organizations_apim_service_extensions_get
organizations_apim_service_extensions_list

Gets APIM service extension details.

SELECT
name,
createTime,
extensionProcessor,
extensions,
lbForwardingRule,
network,
networkConfigs,
state,
updateTime
FROM google.apigee.apim_service_extensions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apimServiceExtensionsId = '{{ apimServiceExtensionsId }}' -- required
;

Lists all APIM service extensions in an organization.

SELECT
name,
createTime,
extensionProcessor,
extensions,
lbForwardingRule,
network,
networkConfigs,
state,
updateTime
FROM google.apigee.apim_service_extensions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

organizations_apim_service_extensions_create
Manifest

Creates an APIM ServiceExtension in an organization.

INSERT INTO google.apigee.apim_service_extensions (
data__lbForwardingRule,
data__networkConfigs,
data__name,
data__extensions,
data__extensionProcessor,
data__network,
organizationsId,
apimServiceExtensionId
)
SELECT 
'{{ lbForwardingRule }}',
'{{ networkConfigs }}',
'{{ name }}',
'{{ extensions }}',
'{{ extensionProcessor }}',
'{{ network }}',
'{{ organizationsId }}',
'{{ apimServiceExtensionId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: apim_service_extensions
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the apim_service_extensions resource.
  - name: lbForwardingRule
    value: "{{ lbForwardingRule }}"
    description: |
      Required. Name of the Google Cloud LB forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} projects/{project}/global/forwardingRules/{forwarding_rule}
  - name: networkConfigs
    description: |
      Required. List of network configurations for the APIM service extension.
    value:
      - region: "{{ region }}"
        subnet: "{{ subnet }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
  - name: extensions
    description: |
      Optional. List of extensions that are part of the service extension. Refer to https://cloud.google.com/service-extensions/docs/quotas#limits for any limits.
    value:
      - name: "{{ name }}"
        matchCondition: "{{ matchCondition }}"
        hostname: "{{ hostname }}"
        failOpen: {{ failOpen }}
        supportedEvents: "{{ supportedEvents }}"
  - name: extensionProcessor
    value: "{{ extensionProcessor }}"
    description: |
      Required. Name of the proxy deployed in the Apigee X instance.
  - name: network
    value: "{{ network }}"
    description: |
      Required. The network where the forwarding rule is created. Format: projects/{project}/global/networks/{network}
  - name: apimServiceExtensionId
    value: "{{ apimServiceExtensionId }}"

`UPDATE` examples

organizations_apim_service_extensions_patch

Updates an APIM service extension in an organization.

UPDATE google.apigee.apim_service_extensions
SET 
data__lbForwardingRule = '{{ lbForwardingRule }}',
data__networkConfigs = '{{ networkConfigs }}',
data__name = '{{ name }}',
data__extensions = '{{ extensions }}',
data__extensionProcessor = '{{ extensionProcessor }}',
data__network = '{{ network }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND apimServiceExtensionsId = '{{ apimServiceExtensionsId }}' --required
AND allowMissing = {{ allowMissing}}
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

organizations_apim_service_extensions_delete

Deletes APIM service extension from an organization.

DELETE FROM google.apigee.apim_service_extensions
WHERE organizationsId = '{{ organizationsId }}' --required
AND apimServiceExtensionsId = '{{ apimServiceExtensionsId }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​