SqlExtensions.GetLongTermRetentionBackupsWithServerAsync 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.
Overloads
| GetLongTermRetentionBackupsWithServerAsync(ResourceGroupResource, AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken) |
Lists the long term retention backups for a given server based on resource groups.
|
| GetLongTermRetentionBackupsWithServerAsync(SubscriptionResource, AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken) |
Lists the long term retention backups for a given server.
|
GetLongTermRetentionBackupsWithServerAsync(ResourceGroupResource, AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)
- Source:
- SqlExtensions.cs
- Source:
- SqlExtensions.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 static Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithServerAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, 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.ResourceGroupResource * 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 (resourceGroupResource As ResourceGroupResource, 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
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance 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.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.
Exceptions
longTermRetentionServerName is an empty string, and was expected to be non-empty.
resourceGroupResource or longTermRetentionServerName is null.
Applies to
GetLongTermRetentionBackupsWithServerAsync(SubscriptionResource, AzureLocation, String, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)
- Source:
- SqlExtensions.cs
- Source:
- SqlExtensions.cs
Lists the long term retention backups for a given server.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups
- Operation Id: LongTermRetentionBackups_ListByServer
- Default Api Version: 2023-05-01-preview
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 instance 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.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.
Exceptions
longTermRetentionServerName is an empty string, and was expected to be non-empty.
subscriptionResource or longTermRetentionServerName is null.
