SqlExtensions.GetLongTermRetentionBackupsWithLocationAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Sql
Assembly:
Azure.ResourceManager.Sql.dll
Package:
Azure.ResourceManager.Sql v1.2.1
Package:
Azure.ResourceManager.Sql v1.3.0-beta.9

Overloads

GetLongTermRetentionBackupsWithLocationAsync(ResourceGroupResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)

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
GetLongTermRetentionBackupsWithLocationAsync(SubscriptionResource, AzureLocation, Nullable<Boolean>, Nullable<SqlDatabaseState>, CancellationToken)

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

GetLongTermRetentionBackupsWithLocationAsync(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.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithLocationAsync (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 GetLongTermRetentionBackupsWithLocationAsync : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithLocationAsync (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 AsyncPageable(Of LongTermRetentionBackupData)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

locationName
AzureLocation

The location of the database.

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

ArgumentNullException

resourceGroupResource is null.

Applies to

GetLongTermRetentionBackupsWithLocationAsync(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.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithLocationAsync (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 GetLongTermRetentionBackupsWithLocationAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>
<Extension()>
Public Function GetLongTermRetentionBackupsWithLocationAsync (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 AsyncPageable(Of LongTermRetentionBackupData)

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

locationName
AzureLocation

The location of the database.

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

ArgumentNullException

subscriptionResource is null.

Applies to