keyvaluemaps

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

Overview

Name	keyvaluemaps
Type	Resource
Id	google.apigee.keyvaluemaps

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_apis_keyvaluemaps_create	insert	organizationsId, apisId		Creates a key value map in an API proxy.
organizations_environments_keyvaluemaps_create	insert	organizationsId, environmentsId		Creates a key value map in an environment.
organizations_keyvaluemaps_create	insert	organizationsId		Creates a key value map in an organization.
organizations_apis_keyvaluemaps_delete	delete	organizationsId, apisId, keyvaluemapsId		Deletes a key value map from an API proxy.
organizations_environments_keyvaluemaps_delete	delete	organizationsId, environmentsId, keyvaluemapsId		Deletes a key value map from an environment.
organizations_keyvaluemaps_delete	delete	organizationsId, keyvaluemapsId		Deletes a key value map 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
apisId	string
environmentsId	string
keyvaluemapsId	string
organizationsId	string

INSERT examples

organizations_apis_keyvaluemaps_create

Creates a key value map in an API proxy.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__encrypted,
organizationsId,
apisId
)
SELECT 
'{{ name }}',
{{ encrypted }},
'{{ organizationsId }}',
'{{ apisId }}'
RETURNING
name,
encrypted
;

organizations_environments_keyvaluemaps_create

Creates a key value map in an environment.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__encrypted,
organizationsId,
environmentsId
)
SELECT 
'{{ name }}',
{{ encrypted }},
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
encrypted
;

organizations_keyvaluemaps_create

Creates a key value map in an organization.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__encrypted,
organizationsId
)
SELECT 
'{{ name }}',
{{ encrypted }},
'{{ organizationsId }}'
RETURNING
name,
encrypted
;

Manifest

# Description fields are for documentation purposes
- name: keyvaluemaps
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: apisId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: environmentsId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: name
      value: string
      description: >
        Required. ID of the key value map.
        
    - name: encrypted
      value: boolean
      description: >
        Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
        

DELETE examples

organizations_apis_keyvaluemaps_delete

Deletes a key value map from an API proxy.

DELETE FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required;

organizations_environments_keyvaluemaps_delete

Deletes a key value map from an environment.

DELETE FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required;

organizations_keyvaluemaps_delete

Deletes a key value map from an organization.

DELETE FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required;