SqlExtensions.GetSubscriptionLongTermRetentionBackupAsync 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.7

Source:: SqlExtensions.cs

Source:: SqlExtensions.cs

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.

Gets a long term retention backup.

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

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.SubscriptionLongTermRetentionBackupResource>> GetSubscriptionLongTermRetentionBackupAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation locationName, string longTermRetentionServerName, string longTermRetentionDatabaseName, string backupName, System.Threading.CancellationToken cancellationToken = default);

static member GetSubscriptionLongTermRetentionBackupAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sql.SubscriptionLongTermRetentionBackupResource>>

<Extension()>
Public Function GetSubscriptionLongTermRetentionBackupAsync (subscriptionResource As SubscriptionResource, locationName As AzureLocation, longTermRetentionServerName As String, longTermRetentionDatabaseName As String, backupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SubscriptionLongTermRetentionBackupResource))

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.

longTermRetentionDatabaseName: String

The name of the database.

backupName: String

The backup name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<SubscriptionLongTermRetentionBackupResource>>

Exceptions

ArgumentNullException

subscriptionResource, longTermRetentionServerName, longTermRetentionDatabaseName or backupName is null.

ArgumentException

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

Applies to