BlobContainersOperations interface

beginObjectLevelWorm: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginObjectLevelWormAndWait: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<void>

Property Value

Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.

clearLegalHold: (resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams) => Promise<LegalHold>

Property Value

Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

create: (resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams) => Promise<BlobContainer>

Property Value

Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.

createOrUpdateImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

Property Value

Deletes specified container under its account.

delete: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams) => Promise<void>

Property Value

Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, the only way is to delete the container after deleting all expired blobs inside the policy locked container.

deleteImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

Property Value

Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.

extendImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

Property Value

Gets properties of a specified container.

get: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams) => Promise<BlobContainer>

Property Value

Gets the existing immutability policy along with the corresponding ETag in response headers and body.

getImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

Property Value

The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

lease: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams) => Promise<LeaseContainerResponse>

Property Value

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

list: (resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams) => PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>

Property Value

Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.

lockImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

Property Value

This operation migrates a blob container from container level WORM to object level immutability enabled container. Prerequisites require a container level immutability policy either in locked or unlocked state, Account level versioning must be enabled and there should be no Legal hold on the container.

objectLevelWorm: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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.

setLegalHold: (resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams) => Promise<LegalHold>

Property Value

Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist.

update: (resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams) => Promise<BlobContainer>

Property Value