Skip to main content

region_keymanager_secrets

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

Overview​

Nameregion_keymanager_secrets
TypeResource
Idovh.cloud.region_keymanager_secrets

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idstring (uuid)ID of the secret
namestringName of the secret
regionstringSecret region

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectregion_name, secret_id, service_nameGet details about a secret
listselectregion_name, service_nameList secrets
deletedeleteregion_name, secret_id, service_nameDelete a secret

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.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
region_namestringRegion name (wire: regionName)
secret_idstring (uuid)Secret ID (wire: secretId)
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples​

Get details about a secret

SELECT
id,
name,
region
FROM ovh.cloud.region_keymanager_secrets
WHERE region_name = '{{ region_name }}' -- required
AND secret_id = '{{ secret_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

DELETE examples​

Delete a secret

DELETE FROM ovh.cloud.region_keymanager_secrets
WHERE region_name = '{{ region_name }}' --required
AND secret_id = '{{ secret_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;