MockableSqlResourceGroupResource.GetLongTermRetentionBackupsWithServerAsync Method

Definition

Namespace:

Azure.ResourceManager.Sql.Mocking

Assembly:

Azure.ResourceManager.Sql.dll

Package:

Azure.ResourceManager.Sql v1.2.1

Source:

MockableSqlResourceGroupResource.cs

Lists the long term retention backups for a given server based on resource groups.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups
• Operation Id: LongTermRetentionBackups_ListByResourceGroupServer
• Default Api Version: 2023-05-01-preview

public virtual Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithServerAsync (Azure.Core.AzureLocation locationName, string longTermRetentionServerName, bool? onlyLatestPerDatabase = default, Azure.ResourceManager.Sql.Models.SqlDatabaseState? databaseState = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetLongTermRetentionBackupsWithServerAsync : Azure.Core.AzureLocation * string * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
override this.GetLongTermRetentionBackupsWithServerAsync : Azure.Core.AzureLocation * string * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>

Public Overridable Function GetLongTermRetentionBackupsWithServerAsync (locationName As AzureLocation, longTermRetentionServerName As String, Optional onlyLatestPerDatabase As Nullable(Of Boolean) = Nothing, Optional databaseState As Nullable(Of SqlDatabaseState) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of LongTermRetentionBackupData)

Parameters

locationName

AzureLocation

The location of the database.

longTermRetentionServerName

String

The name of the server.

onlyLatestPerDatabase

Nullable<Boolean>

Whether or not to only get the latest backup for each database.

databaseState

Nullable<SqlDatabaseState>

Whether to query against just live databases, just deleted databases, or all databases.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<LongTermRetentionBackupData>

An async collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.

Exceptions

ArgumentException

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

ArgumentNullException

longTermRetentionServerName is null.