LongTermRetentionPolicyCollection.CreateOrUpdateAsync Method

Definition

Set or update a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_CreateOrUpdate
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.LongTermRetentionPolicyResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Sql.Models.LongTermRetentionPolicyName policyName, Azure.ResourceManager.Sql.LongTermRetentionPolicyData data, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * Azure.ResourceManager.Sql.Models.LongTermRetentionPolicyName * Azure.ResourceManager.Sql.LongTermRetentionPolicyData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.LongTermRetentionPolicyResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * Azure.ResourceManager.Sql.Models.LongTermRetentionPolicyName * Azure.ResourceManager.Sql.LongTermRetentionPolicyData * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.LongTermRetentionPolicyResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, policyName As LongTermRetentionPolicyName, data As LongTermRetentionPolicyData, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of LongTermRetentionPolicyResource))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

policyName
LongTermRetentionPolicyName

The policy name. Should always be Default.

data
LongTermRetentionPolicyData

The long term retention policy info.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

data is null.

Applies to