BlobBaseClient.SetLegalHoldAsync(Boolean, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Blobs.Specialized

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.19.1

Package:: Azure.Storage.Blobs v12.20.0-beta.2

Source:: BlobBaseClient.cs

Source:: BlobBaseClient.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.

Sets a legal hold on the blob. Note that Blob Versioning must be enabled on your storage account, and the blob must be in a Container with immutable storage with versioning enabled to call this API.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobLegalHoldResult>> SetLegalHoldAsync (bool hasLegalHold, System.Threading.CancellationToken cancellationToken = default);

abstract member SetLegalHoldAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobLegalHoldResult>>
override this.SetLegalHoldAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobLegalHoldResult>>

Public Overridable Function SetLegalHoldAsync (hasLegalHold As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BlobLegalHoldResult))

Parameters

hasLegalHold: Boolean

Set to true to set a legal hold on the blob. Set to false to remove an existing legal hold.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<BlobLegalHoldResult>>

A Response<T>.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to