BlobContainerResource.SetLegalHoldAsync(LegalHold, CancellationToken) Method
Definition
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 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 System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>> SetLegalHoldAsync (Azure.ResourceManager.Storage.Models.LegalHold legalHold, System.Threading.CancellationToken cancellationToken = default);abstract member SetLegalHoldAsync : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>>
override this.SetLegalHoldAsync : Azure.ResourceManager.Storage.Models.LegalHold * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.Models.LegalHold>>Public Overridable Function SetLegalHoldAsync (legalHold As LegalHold, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
