cassandra_clusters_backups
Creates, updates, deletes, gets or lists a cassandra_clusters_backups resource.
Overview
| Name | cassandra_clusters_backups |
| Type | Resource |
| Id | azure.cosmos_db.cassandra_clusters_backups |
Fields
The following fields are returned by SELECT queries:
- get
- list
Successfully retrieved the properties of the backup.
| Name | Datatype | Description |
|---|---|---|
backupExpiryTimestamp | string (date-time) | The time at which the backup will expire. |
backupId | string | The unique identifier of backup. |
backupStartTimestamp | string (date-time) | The time at which the backup process begins. |
backupState | string | The current state of the backup. |
backupStopTimestamp | string (date-time) | The time at which the backup process ends. |
Successfully retrieved the list of restorable backups for this Cassandra cluster.
| Name | Datatype | Description |
|---|---|---|
backupExpiryTimestamp | string (date-time) | The time at which the backup will expire. |
backupId | string | The unique identifier of backup. |
backupStartTimestamp | string (date-time) | The time at which the backup process begins. |
backupState | string | The current state of the backup. |
backupStopTimestamp | string (date-time) | The time at which the backup process ends. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, clusterName, backupId | Get the properties of an individual backup of this cluster that is available to restore. | |
list | select | subscriptionId, resourceGroupName, clusterName | List the backups of this cluster that are available to restore. |
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 |
|---|---|---|
backupId | string | Id of a restorable backup of a Cassandra cluster. |
clusterName | string | Managed Cassandra cluster name. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
SELECT examples
- get
- list
Get the properties of an individual backup of this cluster that is available to restore.
SELECT
backupExpiryTimestamp,
backupId,
backupStartTimestamp,
backupState,
backupStopTimestamp
FROM azure.cosmos_db.cassandra_clusters_backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND backupId = '{{ backupId }}' -- required
;
List the backups of this cluster that are available to restore.
SELECT
backupExpiryTimestamp,
backupId,
backupStartTimestamp,
backupState,
backupStopTimestamp
FROM azure.cosmos_db.cassandra_clusters_backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;