region_keymanager_secrets
Creates, updates, deletes, gets or lists a region_keymanager_secrets resource.
Overview​
| Name | region_keymanager_secrets |
| Type | Resource |
| Id | ovh.cloud.region_keymanager_secrets |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | ID of the secret |
name | string | Name of the secret |
region | string | Secret region |
secret
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | ID of the secret |
name | string | Name of the secret |
region | string | Secret region |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | region_name, secret_id, service_name | Get details about a secret | |
list | select | region_name, service_name | List secrets | |
delete | delete | region_name, secret_id, service_name | Delete 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.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The 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_name | string | Region name (wire: regionName) |
secret_id | string (uuid) | Secret ID (wire: secretId) |
service_name | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
SELECT examples​
- get
- list
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
;
List secrets
SELECT
id,
name,
region
FROM ovh.cloud.region_keymanager_secrets
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;
DELETE examples​
- delete
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
;