CassandraClusterResource.GetBackupAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.9

Source:: CassandraClusterResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get the properties of an individual backup of this cluster that is available to restore.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/backups/{backupId}
Operation Id: CassandraClusters_GetBackup
Default Api Version: 2024-02-15-preview
Resource: CassandraClusterResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.Models.CassandraClusterBackupResourceInfo>> GetBackupAsync (string backupId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetBackupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.Models.CassandraClusterBackupResourceInfo>>
override this.GetBackupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.Models.CassandraClusterBackupResourceInfo>>

Public Overridable Function GetBackupAsync (backupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CassandraClusterBackupResourceInfo))

Parameters

backupId: String

Id of a restorable backup of a Cassandra cluster.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<CassandraClusterBackupResourceInfo>>

Exceptions

ArgumentException

backupId is an empty string, and was expected to be non-empty.

ArgumentNullException

backupId is null.

Applies to

Share via