tenants

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

Overview

Name	tenants
Type	Resource
Id	ovh.backup_services.tenants

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup tenant
created_at	string (date-time)	Date and time the backup tenant is created (wire: createdAt)
current_state	object	Current operational state of the backup tenant (wire: currentState)
current_tasks	array	List of tasks that are currently running for the backup tenant (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Readiness status of the backup tenant (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Specification of the target state of the backup tenant (wire: targetSpec)
updated_at	string (date-time)	Date and time the backup tenant is last updated (wire: updatedAt)

list

Backup tenant resource

Name	Datatype	Description
id	string (uuid)	Unique identifier of the backup tenant
created_at	string (date-time)	Date and time the backup tenant is created (wire: createdAt)
current_state	object	Current operational state of the backup tenant (wire: currentState)
current_tasks	array	List of tasks that are currently running for the backup tenant (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Readiness status of the backup tenant (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Specification of the target state of the backup tenant (wire: targetSpec)
updated_at	string (date-time)	Date and time the backup tenant is last updated (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_services_id		Retrieves the details of your backup tenant
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Retrieves the backup tenants you manage

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"}})
backup_services_id	string (uuid)	Backup services ID (wire: backupServicesId)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Retrieves the details of your backup tenant

SELECT
id,
created_at,
current_state,
current_tasks,
iam,
resource_status,
target_spec,
updated_at
FROM ovh.backup_services.tenants
WHERE backup_services_id = '{{ backup_services_id }}' -- required
;

list

Retrieves the backup tenants you manage

SELECT
id,
created_at,
current_state,
current_tasks,
iam,
resource_status,
target_spec,
updated_at
FROM ovh.backup_services.tenants
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;