SqlExtensions.GetLongTermRetentionBackupsWithServer Method
Definition
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.
Lists the long term retention backups for a given server. <item> Mocking. To mock this method, please mock GetLongTermRetentionBackupsWithServer(AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, String, Nullable<Int64>, CancellationToken) instead. </item>
public static Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithServer(this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation locationName, string longTermRetentionServerName, bool? onlyLatestPerDatabase = default, Azure.ResourceManager.Sql.Models.SqlDatabaseState? databaseState = default, string skiptoken = default, long? top = default, System.Threading.CancellationToken cancellationToken = default);
static member GetLongTermRetentionBackupsWithServer : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * string * Nullable<int64> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithServer (subscriptionResource As SubscriptionResource, locationName As AzureLocation, longTermRetentionServerName As String, Optional onlyLatestPerDatabase As Nullable(Of Boolean) = Nothing, Optional databaseState As Nullable(Of SqlDatabaseState) = Nothing, Optional skiptoken As String = Nothing, Optional top As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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.
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.
- skiptoken
- String
An opaque token that identifies a starting point in the collection.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
A collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.
Exceptions
subscriptionResource is null.