Langue

SqlExtensions.GetLongTermRetentionBackupsWithServerAsync Method

Definition

Namespace:
Azure.ResourceManager.Sql
Assembly:
Azure.ResourceManager.Sql.dll
Package:
Azure.ResourceManager.Sql v1.4.0
Package:
Azure.ResourceManager.Sql v1.5.0-beta.1
Source:
SqlExtensions.cs
Source:
SqlExtensions.cs

Lists the long term retention backups for a given server. <item> Mocking. To mock this method, please mock GetLongTermRetentionBackupsWithServerAsync(AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken) instead. </item>

public static Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithServerAsync(this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation locationName, string longTermRetentionServerName, bool? onlyLatestPerDatabase = default, Azure.ResourceManager.Sql.Models.SqlDatabaseState? databaseState = default, System.Threading.CancellationToken cancellationToken = default);
static member GetLongTermRetentionBackupsWithServerAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithServerAsync (subscriptionResource As SubscriptionResource, 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

subscriptionResource
SubscriptionResource

The SubscriptionResource the method will execute against.

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>

A 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

subscriptionResource is null.

Applies to