SqlExtensions.GetLongTermRetentionBackupsWithResourceGroupServer Method

Definition

Namespace:

Azure.ResourceManager.Sql

Assembly:

Azure.ResourceManager.Sql.dll

Package:

Azure.ResourceManager.Sql v1.5.0-beta.1

Source:

SqlExtensions.cs

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

public static Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData> GetLongTermRetentionBackupsWithResourceGroupServer(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 GetLongTermRetentionBackupsWithResourceGroupServer : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * string * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseState> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.LongTermRetentionBackupData>

<Extension()>
Public Function GetLongTermRetentionBackupsWithResourceGroupServer (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 Pageable(Of LongTermRetentionBackupData)

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource 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

Pageable<LongTermRetentionBackupData>

A collection of LongTermRetentionBackupData that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

resourceGroupResource is null.