BlobContainersOperationsExtensions.SetLegalHoldAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Storage

Assembly:

Microsoft.Azure.Management.Storage.dll

Package:

Microsoft.Azure.Management.Storage v25.0.0

Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.Storage.Models.LegalHold> SetLegalHoldAsync (this Microsoft.Azure.Management.Storage.IBlobContainersOperations operations, string resourceGroupName, string accountName, string containerName, System.Collections.Generic.IList<string> tags, bool? allowProtectedAppendWritesAll = default, System.Threading.CancellationToken cancellationToken = default);

static member SetLegalHoldAsync : Microsoft.Azure.Management.Storage.IBlobContainersOperations * string * string * string * System.Collections.Generic.IList<string> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.Storage.Models.LegalHold>

<Extension()>
Public Function SetLegalHoldAsync (operations As IBlobContainersOperations, resourceGroupName As String, accountName As String, containerName As String, tags As IList(Of String), Optional allowProtectedAppendWritesAll As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of LegalHold)

Parameters

operations

IBlobContainersOperations

The operations group for this extension method.

resourceGroupName

String

The name of the resource group within the user's subscription. The name is case insensitive.

accountName

String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

containerName

String

The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

tags

IList<String>

Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP.

allowProtectedAppendWritesAll

Nullable<Boolean>

When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<LegalHold>