SqlExtensions.GetResourceGroupLongTermRetentionBackupAsync Method

Definition

Namespace:

Azure.ResourceManager.Sql

Assembly:

Azure.ResourceManager.Sql.dll

Package:

Azure.ResourceManager.Sql v1.2.1

Source:

SqlExtensions.cs

Gets a long term retention backup.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}
• Operation Id: LongTermRetentionBackups_GetByResourceGroup
• Default Api Version: 2023-05-01-preview
• Resource: ResourceGroupLongTermRetentionBackupResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.ResourceGroupLongTermRetentionBackupResource>> GetResourceGroupLongTermRetentionBackupAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.Core.AzureLocation locationName, string longTermRetentionServerName, string longTermRetentionDatabaseName, string backupName, System.Threading.CancellationToken cancellationToken = default);

static member GetResourceGroupLongTermRetentionBackupAsync : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.ResourceGroupLongTermRetentionBackupResource>>

<Extension()>
Public Function GetResourceGroupLongTermRetentionBackupAsync (resourceGroupResource As ResourceGroupResource, locationName As AzureLocation, longTermRetentionServerName As String, longTermRetentionDatabaseName As String, backupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ResourceGroupLongTermRetentionBackupResource))

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.

longTermRetentionDatabaseName

String

The name of the database.

backupName

String

The backup name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<ResourceGroupLongTermRetentionBackupResource>>

Exceptions

ArgumentNullException

resourceGroupResource, longTermRetentionServerName, longTermRetentionDatabaseName or backupName is null.

ArgumentException

longTermRetentionServerName, longTermRetentionDatabaseName or backupName is an empty string, and was expected to be non-empty.