SqlExtensions.GetLongTermRetentionBackupsWithLocation 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
GetLongTermRetentionBackupsWithLocation(ResourceGroupResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken) |
Lists the long term retention backups for a given location based on resource group.
|
GetLongTermRetentionBackupsWithLocation(SubscriptionResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken) |
Lists the long term retention backups for a given location.
|
GetLongTermRetentionBackupsWithLocation(ResourceGroupResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)
- Source:
- SqlExtensions.cs
- Source:
- SqlExtensions.cs
Lists the long term retention backups for a given location based on resource group.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups
- Operation Id: LongTermRetentionBackups_ListByResourceGroupLocation
- Default Api Version: 2023-05-01-preview
public static Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithLocation (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.Core.AzureLocation locationName, bool? onlyLatestPerDatabase = default, Azure.ResourceManager.Sql.Models.SqlDatabaseState? databaseState = default, System.Threading.CancellationToken cancellationToken = default);
static member GetLongTermRetentionBackupsWithLocation : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithLocation (resourceGroupResource As ResourceGroupResource, locationName As AzureLocation, Optional onlyLatestPerDatabase As Nullable(Of Boolean) = Nothing, Optional databaseState As Nullable(Of SqlDatabaseState) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of LongTermRetentionBackupData)
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
- locationName
- AzureLocation
The location of the database.
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
A collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.
Exceptions
resourceGroupResource
is null.
Applies to
GetLongTermRetentionBackupsWithLocation(SubscriptionResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)
- Source:
- SqlExtensions.cs
- Source:
- SqlExtensions.cs
Lists the long term retention backups for a given location.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups
- Operation Id: LongTermRetentionBackups_ListByLocation
- Default Api Version: 2023-05-01-preview
public static Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithLocation (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation locationName, bool? onlyLatestPerDatabase = default, Azure.ResourceManager.Sql.Models.SqlDatabaseState? databaseState = default, System.Threading.CancellationToken cancellationToken = default);
static member GetLongTermRetentionBackupsWithLocation : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithLocation (subscriptionResource As SubscriptionResource, locationName As AzureLocation, Optional onlyLatestPerDatabase As Nullable(Of Boolean) = Nothing, Optional databaseState As Nullable(Of SqlDatabaseState) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of LongTermRetentionBackupData)
Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
- locationName
- AzureLocation
The location of the database.
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
A collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.
Exceptions
subscriptionResource
is null.
Applies to
Azure SDK for .NET