tenant_vspc_managed_backups

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

Overview

Name	tenant_vspc_managed_backups
Type	Resource
Id	ovh.backup_services.tenant_vspc_managed_backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the Managed Backup service, formatted managed-backup- followed by the service name of the protected Hosted Private Cloud
created_at	string (date-time)	Date and time when the service is created (wire: createdAt)
current_state	object	Current state of the service (wire: currentState)
current_tasks	array	Current tasks running on the service (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Indicates the readiness of the service. SUSPENDED while backup schedules are stopped. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Target specification for the service (wire: targetSpec)
updated_at	string (date-time)	Date and time when the service is last updated (wire: updatedAt)

list

Represents a Managed Backup service protecting one Hosted Private Cloud. Ordered and terminated through the OVHcloud Control Panel.

Name	Datatype	Description
id	string	Unique identifier of the Managed Backup service, formatted managed-backup- followed by the service name of the protected Hosted Private Cloud
created_at	string (date-time)	Date and time when the service is created (wire: createdAt)
current_state	object	Current state of the service (wire: currentState)
current_tasks	array	Current tasks running on the service (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Indicates the readiness of the service. SUSPENDED while backup schedules are stopped. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Target specification for the service (wire: targetSpec)
updated_at	string (date-time)	Date and time when the service 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, managed_backup_id, vspc_tenant_id		Retrieves a Managed Backup service of the VSPC tenant
list	select	backup_services_id, vspc_tenant_id	x_pagination_cursor, x_pagination_size, iam_tags	Retrieves the Managed Backup services of the VSPC tenant, one per protected Hosted Private Cloud; empty when the Managed Backup add-on is not enabled
update	update	backup_services_id, managed_backup_id, vspc_tenant_id, display_name		Updates the display name of a Managed Backup service
reset_password	exec	backupServicesId, managedBackupId, vspcTenantId		The account is the one reported in currentState.vbrLogin. The new password is generated by the platform and delivered to the contacts of your account. It is never returned by the API. Accepted on a READY or SUSPENDED service without a password reset already in progress.

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"}})
backupServicesId	string (uuid)	Backup services ID
backup_services_id	string (uuid)	Backup services ID (wire: backupServicesId)
managedBackupId	string	Managed backup ID
managed_backup_id	string	Managed backup ID (wire: managedBackupId)
vspcTenantId	string (uuid)	Vspc tenant ID
vspc_tenant_id	string (uuid)	Vspc tenant ID (wire: vspcTenantId)
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 a Managed Backup service of the VSPC tenant

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

list

Retrieves the Managed Backup services of the VSPC tenant, one per protected Hosted Private Cloud; empty when the Managed Backup add-on is not enabled

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

UPDATE examples

update

Updates the display name of a Managed Backup service

UPDATE ovh.backup_services.tenant_vspc_managed_backups
SET 
display_name = '{{ display_name }}'
WHERE 
backup_services_id = '{{ backup_services_id }}' --required
AND managed_backup_id = '{{ managed_backup_id }}' --required
AND vspc_tenant_id = '{{ vspc_tenant_id }}' --required
AND display_name = '{{ display_name }}' --required
RETURNING
id,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at;

Lifecycle Methods

EXEC variables use wire (API) names.

reset_password

The account is the one reported in currentState.vbrLogin. The new password is generated by the platform and delivered to the contacts of your account. It is never returned by the API. Accepted on a READY or SUSPENDED service without a password reset already in progress.

EXEC ovh.backup_services.tenant_vspc_managed_backups.reset_password 
@backupServicesId='{{ backupServicesId }}' --required, 
@managedBackupId='{{ managedBackupId }}' --required, 
@vspcTenantId='{{ vspcTenantId }}' --required
;