key_rings

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

Overview

Name	key_rings
Type	Resource
Id	google.cloudkms.key_rings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
createTime	string (google-datetime)	Output only. The time at which this KeyRing was created.

list

Name	Datatype	Description
name	string	Output only. The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.
createTime	string (google-datetime)	Output only. The time at which this KeyRing was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, keyRingsId		Returns metadata for a given KeyRing.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists KeyRings.
create	insert	projectsId, locationsId	keyRingId	Create a new KeyRing in a given Project and Location.

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
keyRingsId	string
locationsId	string
projectsId	string
filter	string
keyRingId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Returns metadata for a given KeyRing.

SELECT
name,
createTime
FROM google.cloudkms.key_rings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND keyRingsId = '{{ keyRingsId }}' -- required
;

list

Lists KeyRings.

SELECT
name,
createTime
FROM google.cloudkms.key_rings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Create a new KeyRing in a given Project and Location.

INSERT INTO google.cloudkms.key_rings (
projectsId,
locationsId,
keyRingId
)
SELECT 
'{{ projectsId }}',
'{{ locationsId }}',
'{{ keyRingId }}'
RETURNING
name,
createTime
;

Manifest

# Description fields are for documentation purposes
- name: key_rings
  props:
    - name: projectsId
      value: string
      description: Required parameter for the key_rings resource.
    - name: locationsId
      value: string
      description: Required parameter for the key_rings resource.
    - name: keyRingId
      value: string