BlobContainerResource.ClearLegalHoldAsync Method

Definition

Namespace:

Azure.ResourceManager.Storage

Assembly:

Azure.ResourceManager.Storage.dll

Package:

Azure.ResourceManager.Storage v1.3.0

Source:

BlobContainerResource.cs

Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold
• Operation Id: BlobContainers_ClearLegalHold
• Default Api Version: 2023-05-01
• Resource: BlobContainerResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>> ClearLegalHoldAsync (Azure.ResourceManager.Storage.Models.LegalHold legalHold, System.Threading.CancellationToken cancellationToken = default);

abstract member ClearLegalHoldAsync : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>>
override this.ClearLegalHoldAsync : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>>

Public Overridable Function ClearLegalHoldAsync (legalHold As LegalHold, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of LegalHold))

Parameters

legalHold

LegalHold

The LegalHold property that will be clear from a blob container.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<LegalHold>>

Exceptions

ArgumentNullException

legalHold is null.