BlobContainers interface
Interface representing a BlobContainers.
Methods
| begin |
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. |
| begin |
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. |
| clear |
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. |
| create(string, string, string, Blob |
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 |
Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation. |
| delete(string, string, string, Blob |
Deletes specified container under its account. |
| delete |
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. |
| extend |
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. |
| get(string, string, string, Blob |
Gets properties of a specified container. |
| get |
Gets the existing immutability policy along with the corresponding ETag in response headers and body. |
| lease(string, string, string, Blob |
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. |
| list(string, string, Blob |
Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token. |
| lock |
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. |
| set |
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. |
| update(string, string, string, Blob |
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. |
Method Details
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
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.
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
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.
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
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.
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>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.
The options parameters.
Returns
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
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.
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>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.
The options parameters.
Returns
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>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.
The options parameters.
Returns
delete(string, string, string, BlobContainersDeleteOptionalParams)
Deletes specified container under its account.
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
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.
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>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. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.
The options parameters.
Returns
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
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.
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>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. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.
The options parameters.
Returns
get(string, string, string, BlobContainersGetOptionalParams)
Gets properties of a specified container.
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>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.
- options
- BlobContainersGetOptionalParams
The options parameters.
Returns
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
Gets the existing immutability policy along with the corresponding ETag in response headers and body.
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>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.
The options parameters.
Returns
lease(string, string, string, BlobContainersLeaseOptionalParams)
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.
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>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.
The options parameters.
Returns
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>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.
- options
- BlobContainersListOptionalParams
The options parameters.
Returns
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
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.
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>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. A value of "*" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied.
The options parameters.
Returns
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
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.
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>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.
The options parameters.
Returns
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
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.
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>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.
The options parameters.
Returns
Promise<BlobContainer>