BlobContainerResource.SetLegalHold(LegalHold, 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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold
  • Operation Id: BlobContainers_SetLegalHold
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
public virtual Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold> SetLegalHold (Azure.ResourceManager.Storage.Models.LegalHold legalHold, System.Threading.CancellationToken cancellationToken = default);
abstract member SetLegalHold : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>
override this.SetLegalHold : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>
Public Overridable Function SetLegalHold (legalHold As LegalHold, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LegalHold)

Parameters

legalHold
LegalHold

The LegalHold property that will be set to a blob container.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

legalHold is null.

Applies to