com.microsoft.azure.management.storage

Interface BlobContainers

@Beta
public interface BlobContainers

Type representing BlobContainers.

Method Summary

Modifier and Type	Method and Description
rx.Observable<LegalHold>	clearLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags) Clears legal hold tags.
BlobContainer.DefinitionStages.Blank	defineContainer(String name) Begins definition for a new Container resource.
ImmutabilityPolicy.DefinitionStages.Blank	defineImmutabilityPolicy(String name) Begins definition for a new ImmutabilityPolicy resource.
rx.Completable	deleteAsync(String resourceGroupName, String accountName, String containerName) Deletes specified container under its account.
rx.Completable	deleteImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch) Aborts an unlocked immutability policy.
rx.Observable<ImmutabilityPolicy>	extendImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch, int immutabilityPeriodSinceCreationInDays) Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy.
rx.Observable<BlobContainer>	getAsync(String resourceGroupName, String accountName, String containerName) Gets properties of a specified container.
rx.Observable<ImmutabilityPolicy>	getImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName) Gets the existing immutability policy along with the corresponding ETag in response headers and body.
rx.Observable<ListContainerItems>	listAsync(String resourceGroupName, String accountName) Lists all containers and does not support a prefix like data plane.
rx.Observable<ImmutabilityPolicy>	lockImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch) Sets the ImmutabilityPolicy to Locked state.
rx.Observable<LegalHold>	setLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags) Sets legal hold tags.

Method Detail

defineContainer

BlobContainer.DefinitionStages.Blank defineContainer(String name)

Begins definition for a new Container resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Container definition.

defineImmutabilityPolicy

ImmutabilityPolicy.DefinitionStages.Blank defineImmutabilityPolicy(String name)

Begins definition for a new ImmutabilityPolicy resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ImmutabilityPolicy definition.

listAsync

rx.Observable<ListContainerItems> listAsync(String resourceGroupName,
                                            String accountName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

rx.Observable<BlobContainer> getAsync(String resourceGroupName,
                                      String accountName,
                                      String containerName)

Gets properties of a specified container.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

rx.Completable deleteAsync(String resourceGroupName,
                           String accountName,
                           String containerName)

Deletes specified container under its account.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

setLegalHoldAsync

rx.Observable<LegalHold> setLegalHoldAsync(String resourceGroupName,
                                           String accountName,
                                           String containerName,
                                           List<String> tags)

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 - The name of the resource group within the user's subscription. The name is case insensitive.

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

tags - Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

clearLegalHoldAsync

rx.Observable<LegalHold> clearLegalHoldAsync(String resourceGroupName,
                                             String accountName,
                                             String containerName,
                                             List<String> tags)

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 - The name of the resource group within the user's subscription. The name is case insensitive.

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

tags - Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getImmutabilityPolicyAsync

rx.Observable<ImmutabilityPolicy> getImmutabilityPolicyAsync(String resourceGroupName,
                                                             String accountName,
                                                             String containerName)

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

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteImmutabilityPolicyAsync

rx.Completable deleteImmutabilityPolicyAsync(String resourceGroupName,
                                             String accountName,
                                             String containerName,
                                             String ifMatch)

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, only way is to delete the container after deleting all blobs inside the container.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

lockImmutabilityPolicyAsync

rx.Observable<ImmutabilityPolicy> lockImmutabilityPolicyAsync(String resourceGroupName,
                                                              String accountName,
                                                              String containerName,
                                                              String ifMatch)

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 - The name of the resource group within the user's subscription. The name is case insensitive.

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

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

extendImmutabilityPolicyAsync

rx.Observable<ImmutabilityPolicy> extendImmutabilityPolicyAsync(String resourceGroupName,
                                                                String accountName,
                                                                String containerName,
                                                                String ifMatch,
                                                                int immutabilityPeriodSinceCreationInDays)

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 - The name of the resource group within the user's subscription. The name is case insensitive.

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

immutabilityPeriodSinceCreationInDays - The immutability period for the blobs in the container since the policy creation, in days.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation