IBlobContainersOperations.SetLegalHoldWithHttpMessagesAsync(String, String, String, IList<String>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Storage.Models.LegalHold>> SetLegalHoldWithHttpMessagesAsync (string resourceGroupName, string accountName, string containerName, System.Collections.Generic.IList<string> tags, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SetLegalHoldWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Storage.Models.LegalHold>>
Public Function SetLegalHoldWithHttpMessagesAsync (resourceGroupName As String, accountName As String, containerName As String, tags As IList(Of String), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of LegalHold))

Parameters

resourceGroupName
System.String

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

accountName
System.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
System.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
System.Collections.Generic.IList<System.String>

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

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse<LegalHold>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to