Package version:

Interface BlobContainers

Interface representing a BlobContainers.

interface BlobContainers {
    beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>;
    clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>;
    create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>;
    createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>;
    delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>;
    deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>;
    extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>;
    get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>;
    getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>;
    lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>;
    list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem>;
    lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>;
    setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>;
    update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>;
}

Methods

beginObjectLevelWorm beginObjectLevelWormAndWait clearLegalHold create createOrUpdateImmutabilityPolicy delete deleteImmutabilityPolicy extendImmutabilityPolicy get getImmutabilityPolicy lease list lockImmutabilityPolicy setLegalHold update

Methods

beginObjectLevelWorm

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

  • 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.

    Parameters

    • 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.

    • Optionaloptions: BlobContainersObjectLevelWormOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginObjectLevelWormAndWait

  • beginObjectLevelWormAndWait(resourceGroupName, accountName, containerName, options?): Promise<void>

  • 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.

    Parameters

    • 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.

    • Optionaloptions: BlobContainersObjectLevelWormOptionalParams

      The options parameters.

    Returns Promise<void>

clearLegalHold

  • clearLegalHold(resourceGroupName, accountName, containerName, legalHold, options?): Promise<LegalHold>

  • 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.

    Parameters

    • 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.

    • legalHold: LegalHold

      The LegalHold property that will be clear from a blob container.

    • Optionaloptions: BlobContainersClearLegalHoldOptionalParams

      The options parameters.

    Returns Promise<LegalHold>

create

  • create(resourceGroupName, accountName, containerName, blobContainer, options?): Promise<BlobContainer>

  • 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.

    Parameters

    • 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.

    • blobContainer: BlobContainer

      Properties of the blob container to create.

    • Optionaloptions: BlobContainersCreateOptionalParams

      The options parameters.

    Returns Promise<BlobContainer>

createOrUpdateImmutabilityPolicy

  • createOrUpdateImmutabilityPolicy(resourceGroupName, accountName, containerName, options?): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>

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

    Parameters

    • 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.

    • Optionaloptions: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams

      The options parameters.

    Returns Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>

delete

  • delete(resourceGroupName, accountName, containerName, options?): Promise<void>

  • Deletes specified container under its account.

    Parameters

    • 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.

    • Optionaloptions: BlobContainersDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

deleteImmutabilityPolicy

  • deleteImmutabilityPolicy(resourceGroupName, accountName, containerName, ifMatch, options?): Promise<BlobContainersDeleteImmutabilityPolicyResponse>

  • 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.

    Parameters

    • 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.

    • ifMatch: string

      The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service.

    • Optionaloptions: BlobContainersDeleteImmutabilityPolicyOptionalParams

      The options parameters.

    Returns Promise<BlobContainersDeleteImmutabilityPolicyResponse>

extendImmutabilityPolicy

  • extendImmutabilityPolicy(resourceGroupName, accountName, containerName, ifMatch, options?): Promise<BlobContainersExtendImmutabilityPolicyResponse>

  • 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.

    Parameters

    • 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.

    • ifMatch: string

      The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service.

    • Optionaloptions: BlobContainersExtendImmutabilityPolicyOptionalParams

      The options parameters.

    Returns Promise<BlobContainersExtendImmutabilityPolicyResponse>

get

  • get(resourceGroupName, accountName, containerName, options?): Promise<BlobContainer>

  • Gets properties of a specified container.

    Parameters

    • 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.

    • Optionaloptions: BlobContainersGetOptionalParams

      The options parameters.

    Returns Promise<BlobContainer>

getImmutabilityPolicy

  • getImmutabilityPolicy(resourceGroupName, accountName, containerName, options?): Promise<BlobContainersGetImmutabilityPolicyResponse>

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

    Parameters

    • 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.

    • Optionaloptions: BlobContainersGetImmutabilityPolicyOptionalParams

      The options parameters.

    Returns Promise<BlobContainersGetImmutabilityPolicyResponse>

lease

  • lease(resourceGroupName, accountName, containerName, options?): Promise<LeaseContainerResponse>

  • 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.

    Parameters

    • 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.

    • Optionaloptions: BlobContainersLeaseOptionalParams

      The options parameters.

    Returns Promise<LeaseContainerResponse>

list

  • list(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<ListContainerItem>

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

    Parameters

    • 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.

    • Optionaloptions: BlobContainersListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ListContainerItem>

lockImmutabilityPolicy

  • lockImmutabilityPolicy(resourceGroupName, accountName, containerName, ifMatch, options?): Promise<BlobContainersLockImmutabilityPolicyResponse>

  • 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.

    Parameters

    • 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.

    • ifMatch: string

      The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service.

    • Optionaloptions: BlobContainersLockImmutabilityPolicyOptionalParams

      The options parameters.

    Returns Promise<BlobContainersLockImmutabilityPolicyResponse>

setLegalHold

  • setLegalHold(resourceGroupName, accountName, containerName, legalHold, options?): Promise<LegalHold>

  • 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.

    Parameters

    • 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.

    • legalHold: LegalHold

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

    • Optionaloptions: BlobContainersSetLegalHoldOptionalParams

      The options parameters.

    Returns Promise<LegalHold>

update

  • update(resourceGroupName, accountName, containerName, blobContainer, options?): Promise<BlobContainer>

  • 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.

    Parameters

    • 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.

    • blobContainer: BlobContainer

      Properties to update for the blob container.

    • Optionaloptions: BlobContainersUpdateOptionalParams

      The options parameters.

    Returns Promise<BlobContainer>

Settings

Member Visibility