com.azure.storage.blob

Class BlobContainerClient

java.lang.Object

com.azure.storage.blob.BlobContainerClient

public final class BlobContainerClient
extends Object

Client to a container. It may only be instantiated through a BlobContainerClientBuilder or via the method BlobServiceClient.getBlobContainerClient(String). This class does not hold any state about a particular container but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs.

This client contains operations on a container. Operations on a blob are available on BlobClient through BlobContainerClient.getBlobClient(String), and operations on the service are available on BlobServiceClient.

Please refer to the Azure Docs for more information on containers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CONTAINER_NAME
static String	ROOT_CONTAINER_NAME
static String	STATIC_WEBSITE_CONTAINER_NAME

Method Summary

Modifier and Type	Method and Description
void	create() Creates a new container within a storage account.
com.azure.core.http.rest.Response<Void>	createWithResponse(Map<String,String> metadata, PublicAccessType accessType, Duration timeout, com.azure.core.util.Context context) Creates a new container within a storage account.
void	delete() Marks the specified container for deletion.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Marks the specified container for deletion.
boolean	exists() Gets if the container this client represents exists in the cloud.
com.azure.core.http.rest.Response<Boolean>	existsWithResponse(Duration timeout, com.azure.core.util.Context context) Gets if the container this client represents exists in the cloud.
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues) Generates a service SAS for the container using the specified BlobServiceSasSignatureValues
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, com.azure.core.util.Context context) Generates a service SAS for the container using the specified BlobServiceSasSignatureValues
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey) Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, com.azure.core.util.Context context) Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.
BlobContainerAccessPolicies	getAccessPolicy() Returns the container's permissions.
com.azure.core.http.rest.Response<BlobContainerAccessPolicies>	getAccessPolicyWithResponse(String leaseId, Duration timeout, com.azure.core.util.Context context) Returns the container's permissions.
StorageAccountInfo	getAccountInfo(Duration timeout) Returns the sku name and account kind for the account.
com.azure.core.http.rest.Response<StorageAccountInfo>	getAccountInfoWithResponse(Duration timeout, com.azure.core.util.Context context) Returns the sku name and account kind for the account.
String	getAccountName() Get associated account name.
String	getAccountUrl() Get the url of the storage account.
BlobClient	getBlobClient(String blobName) Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
BlobClient	getBlobClient(String blobName, String snapshot) Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
String	getBlobContainerName() Get the container name.
String	getBlobContainerUrl() Gets the URL of the container represented by this client.
BlobClient	getBlobVersionClient(String blobName, String versionId) Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
CpkInfo	getCustomerProvidedKey() Gets the CpkInfo associated with this client that will be passed to BlobClients when getBlobClient is called.
String	getEncryptionScope() Gets the encryption scope used to encrypt this blob's content on the server.
com.azure.core.http.HttpPipeline	getHttpPipeline() Gets the HttpPipeline powering this client.
BlobContainerProperties	getProperties() Returns the container's metadata and system properties.
com.azure.core.http.rest.Response<BlobContainerProperties>	getPropertiesWithResponse(String leaseId, Duration timeout, com.azure.core.util.Context context) Returns the container's metadata and system properties.
BlobServiceClient	getServiceClient() Get a client pointing to the account.
BlobServiceVersion	getServiceVersion() Gets the service version the client is using.
com.azure.core.http.rest.PagedIterable<BlobItem>	listBlobs() Returns a lazy loaded list of blobs in this container, with folder structures flattened.
com.azure.core.http.rest.PagedIterable<BlobItem>	listBlobs(ListBlobsOptions options, Duration timeout) Returns a lazy loaded list of blobs in this container, with folder structures flattened.
com.azure.core.http.rest.PagedIterable<BlobItem>	listBlobs(ListBlobsOptions options, String continuationToken, Duration timeout) Returns a lazy loaded list of blobs in this container, with folder structures flattened.
com.azure.core.http.rest.PagedIterable<BlobItem>	listBlobsByHierarchy(String directory) Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix).
com.azure.core.http.rest.PagedIterable<BlobItem>	listBlobsByHierarchy(String delimiter, ListBlobsOptions options, Duration timeout) Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory).
void	setAccessPolicy(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers) Sets the container's permissions.
com.azure.core.http.rest.Response<Void>	setAccessPolicyWithResponse(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Sets the container's permissions.
void	setMetadata(Map<String,String> metadata) Sets the container's metadata.
com.azure.core.http.rest.Response<Void>	setMetadataWithResponse(Map<String,String> metadata, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Sets the container's metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT_CONTAINER_NAME

public static final String ROOT_CONTAINER_NAME

See Also:

Constant Field Values

STATIC_WEBSITE_CONTAINER_NAME

public static final String STATIC_WEBSITE_CONTAINER_NAME

See Also:

Constant Field Values

LOG_CONTAINER_NAME

public static final String LOG_CONTAINER_NAME

See Also:

Constant Field Values

Method Detail

getBlobClient

public BlobClient getBlobClient(String blobName)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name.

Code Samples

 BlobClient blobClient = client.getBlobClient(blobName);
 

Returns:

A new BlobClient object which references the blob with the specified name in this container.

getBlobClient

public BlobClient getBlobClient(String blobName,
                                String snapshot)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Code Samples

 BlobClient blobClient = client.getBlobClient(blobName, snapshot);
 

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name.

snapshot - the snapshot identifier for the blob.

Returns:

A new BlobClient object which references the blob with the specified name in this container.

getBlobVersionClient

public BlobClient getBlobVersionClient(String blobName,
                                       String versionId)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name.

versionId - the version identifier for the blob, pass null to interact with the latest blob version.

Returns:

A new BlobClient object which references the blob with the specified name in this container.

getBlobContainerName

public String getBlobContainerName()

Get the container name.

Code Samples

 String containerName = client.getBlobContainerName();
 System.out.println("The name of the blob is " + containerName);
 

Returns:

The name of container.

getAccountUrl

public String getAccountUrl()

Get the url of the storage account.

Returns:

the URL of the storage account

getBlobContainerUrl

public String getBlobContainerUrl()

Gets the URL of the container represented by this client.

Returns:

the URL.

getAccountName

public String getAccountName()

Get associated account name.

Returns:

account name associated with this storage resource.

getServiceClient

public BlobServiceClient getServiceClient()

Get a client pointing to the account.

Returns:

BlobServiceClient

getServiceVersion

public BlobServiceVersion getServiceVersion()

Gets the service version the client is using.

Returns:

the service version the client is using.

getHttpPipeline

public com.azure.core.http.HttpPipeline getHttpPipeline()

Gets the HttpPipeline powering this client.

Returns:

The pipeline.

getCustomerProvidedKey

public CpkInfo getCustomerProvidedKey()

Gets the CpkInfo associated with this client that will be passed to BlobClients when getBlobClient is called.

Returns:

the customer provided key used for encryption.

getEncryptionScope

public String getEncryptionScope()

Gets the encryption scope used to encrypt this blob's content on the server.

Returns:

the encryption scope used for encryption.

exists

public boolean exists()

Gets if the container this client represents exists in the cloud.

Code Samples

 System.out.printf("Exists? %b%n", client.exists());
 

Returns:

true if the container exists, false if it doesn't

existsWithResponse

public com.azure.core.http.rest.Response<Boolean> existsWithResponse(Duration timeout,
                                                                     com.azure.core.util.Context context)

Gets if the container this client represents exists in the cloud.

Code Samples

 Context context = new Context("Key", "Value");
 System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, context).getValue());
 

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

true if the container exists, false if it doesn't

create

public void create()

Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the Azure Docs.

Code Samples

 try {
     client.create();
     System.out.printf("Create completed%n");
 } catch (BlobStorageException error) {
     if (error.getErrorCode().equals(BlobErrorCode.CONTAINER_ALREADY_EXISTS)) {
         System.out.printf("Can't create container. It already exists %n");
     }
 }
 

createWithResponse

public com.azure.core.http.rest.Response<Void> createWithResponse(Map<String,String> metadata,
                                                                  PublicAccessType accessType,
                                                                  Duration timeout,
                                                                  com.azure.core.util.Context context)

Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the Azure Docs.

Code Samples

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 Context context = new Context("Key", "Value");
 
 System.out.printf("Create completed with status %d%n",
     client.createWithResponse(metadata, PublicAccessType.CONTAINER, timeout, context).getStatusCode());
 

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

delete

public void delete()

Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.

Code Samples

 try {
     client.delete();
     System.out.printf("Delete completed%n");
 } catch (BlobStorageException error) {
     if (error.getErrorCode().equals(BlobErrorCode.CONTAINER_NOT_FOUND)) {
         System.out.printf("Delete failed. Container was not found %n");
     }
 }
 

deleteWithResponse

public com.azure.core.http.rest.Response<Void> deleteWithResponse(BlobRequestConditions requestConditions,
                                                                  Duration timeout,
                                                                  com.azure.core.util.Context context)

Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.

Code Samples

 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Context context = new Context("Key", "Value");
 
 System.out.printf("Delete completed with status %d%n", client.deleteWithResponse(
     requestConditions, timeout, context).getStatusCode());
 

Parameters:

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

getProperties

public BlobContainerProperties getProperties()

Returns the container's metadata and system properties. For more information, see the Azure Docs.

Code Samples

 BlobContainerProperties properties = client.getProperties();
 System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
     properties.getBlobPublicAccess(),
     properties.hasLegalHold(),
     properties.hasImmutabilityPolicy());
 

Returns:

The container properties.

getPropertiesWithResponse

public com.azure.core.http.rest.Response<BlobContainerProperties> getPropertiesWithResponse(String leaseId,
                                                                                            Duration timeout,
                                                                                            com.azure.core.util.Context context)

Returns the container's metadata and system properties. For more information, see the Azure Docs.

Code Samples

 Context context = new Context("Key", "Value");
 
 BlobContainerProperties properties = client.getPropertiesWithResponse(leaseId, timeout, context)
     .getValue();
 System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
     properties.getBlobPublicAccess(),
     properties.hasLegalHold(),
     properties.hasImmutabilityPolicy());
 

Parameters:

leaseId - The lease ID the active lease on the container must match.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The container properties.

setMetadata

public void setMetadata(Map<String,String> metadata)

Sets the container's metadata. For more information, see the Azure Docs.

Code Samples

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 try {
     client.setMetadata(metadata);
     System.out.printf("Set metadata completed with status %n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Fail while setting metadata %n");
 }
 

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

setMetadataWithResponse

public com.azure.core.http.rest.Response<Void> setMetadataWithResponse(Map<String,String> metadata,
                                                                       BlobRequestConditions requestConditions,
                                                                       Duration timeout,
                                                                       com.azure.core.util.Context context)

Sets the container's metadata. For more information, see the Azure Docs.

Code Samples

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Context context = new Context("Key", "Value");
 
 System.out.printf("Set metadata completed with status %d%n",
     client.setMetadataWithResponse(metadata, requestConditions, timeout, context).getStatusCode());
 

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

getAccessPolicy

public BlobContainerAccessPolicies getAccessPolicy()

Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see the Azure Docs.

Code Samples

 BlobContainerAccessPolicies accessPolicies = client.getAccessPolicy();
 System.out.printf("Blob Access Type: %s%n", accessPolicies.getBlobAccessType());
 
 for (BlobSignedIdentifier identifier : accessPolicies.getIdentifiers()) {
     System.out.printf("Identifier Name: %s, Permissions %s%n",
         identifier.getId(),
         identifier.getAccessPolicy().getPermissions());
 }
 

Returns:

The container access policy.

getAccessPolicyWithResponse

public com.azure.core.http.rest.Response<BlobContainerAccessPolicies> getAccessPolicyWithResponse(String leaseId,
                                                                                                  Duration timeout,
                                                                                                  com.azure.core.util.Context context)

Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see the Azure Docs.

Code Samples

 Context context = new Context("Key", "Value");
 BlobContainerAccessPolicies accessPolicies = client.getAccessPolicyWithResponse(leaseId, timeout, context)
     .getValue();
 System.out.printf("Blob Access Type: %s%n", accessPolicies.getBlobAccessType());
 
 for (BlobSignedIdentifier identifier : accessPolicies.getIdentifiers()) {
     System.out.printf("Identifier Name: %s, Permissions %s%n",
         identifier.getId(),
         identifier.getAccessPolicy().getPermissions());
 }
 

Parameters:

leaseId - The lease ID the active lease on the container must match.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The container access policy.

setAccessPolicy

public void setAccessPolicy(PublicAccessType accessType,
                            List<BlobSignedIdentifier> identifiers)

Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.

Code Samples

 BlobSignedIdentifier identifier = new BlobSignedIdentifier()
     .setId("name")
     .setAccessPolicy(new BlobAccessPolicy()
         .setStartsOn(OffsetDateTime.now())
         .setExpiresOn(OffsetDateTime.now().plusDays(7))
         .setPermissions("permissionString"));
 
 try {
     client.setAccessPolicy(PublicAccessType.CONTAINER, Collections.singletonList(identifier));
     System.out.printf("Set Access Policy completed %n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Set Access Policy completed %s%n", error);
 }
 

Parameters:

accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.

identifiers - A list of BlobSignedIdentifier objects that specify the permissions for the container. Please see here for more information. Passing null will clear all access policies.

setAccessPolicyWithResponse

public com.azure.core.http.rest.Response<Void> setAccessPolicyWithResponse(PublicAccessType accessType,
                                                                           List<BlobSignedIdentifier> identifiers,
                                                                           BlobRequestConditions requestConditions,
                                                                           Duration timeout,
                                                                           com.azure.core.util.Context context)

Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.

Code Samples

 BlobSignedIdentifier identifier = new BlobSignedIdentifier()
     .setId("name")
     .setAccessPolicy(new BlobAccessPolicy()
         .setStartsOn(OffsetDateTime.now())
         .setExpiresOn(OffsetDateTime.now().plusDays(7))
         .setPermissions("permissionString"));
 
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 
 Context context = new Context("Key", "Value");
 
 System.out.printf("Set access policy completed with status %d%n",
     client.setAccessPolicyWithResponse(PublicAccessType.CONTAINER,
         Collections.singletonList(identifier),
         requestConditions,
         timeout,
         context).getStatusCode());
 

Parameters:

accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.

identifiers - A list of BlobSignedIdentifier objects that specify the permissions for the container. Please see here for more information. Passing null will clear all access policies.

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

listBlobs

public com.azure.core.http.rest.PagedIterable<BlobItem> listBlobs()

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

 client.listBlobs().forEach(blob ->
     System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isPrefix()));
 

Returns:

The listed blobs, flattened.

listBlobs

public com.azure.core.http.rest.PagedIterable<BlobItem> listBlobs(ListBlobsOptions options,
                                                                  Duration timeout)

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

 ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));
 
 client.listBlobs(options, timeout).forEach(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));
 

Parameters:

options - ListBlobsOptions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

The listed blobs, flattened.

listBlobs

public com.azure.core.http.rest.PagedIterable<BlobItem> listBlobs(ListBlobsOptions options,
                                                                  String continuationToken,
                                                                  Duration timeout)

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

 ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));
 
 String continuationToken = "continuationToken";
 
 client.listBlobs(options, continuationToken, timeout).forEach(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));
 

Parameters:

options - ListBlobsOptions

continuationToken - Identifies the portion of the list to be returned with the next list operation.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

The listed blobs, flattened.

listBlobsByHierarchy

public com.azure.core.http.rest.PagedIterable<BlobItem> listBlobsByHierarchy(String directory)

Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix). Directories will have BlobItem.isPrefix() set to true.

Blob names are returned in lexicographic order. For more information, see the Azure Docs.

E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return the following results when prefix=null:

• foo/ (isPrefix = true)
• bar (isPrefix = false)

will return the following results when prefix="foo/":

• foo/foo1 (isPrefix = false)
• foo/foo2 (isPrefix = false)

Code Samples

 client.listBlobsByHierarchy("directoryName").forEach(blob ->
     System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isPrefix()));
 

Parameters:

directory - The directory to list blobs underneath

Returns:

A reactive response emitting the prefixes and blobs.

listBlobsByHierarchy

public com.azure.core.http.rest.PagedIterable<BlobItem> listBlobsByHierarchy(String delimiter,
                                                                             ListBlobsOptions options,
                                                                             Duration timeout)

Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory). Directories will have BlobItem.isPrefix() set to true.

Blob names are returned in lexicographic order. For more information, see the Azure Docs.

E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return the following results when prefix=null:

• foo/ (isPrefix = true)
• bar (isPrefix = false)

will return the following results when prefix="foo/":

• foo/foo1 (isPrefix = false)
• foo/foo2 (isPrefix = false)

Code Samples

 ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("directoryName")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));
 
 client.listBlobsByHierarchy("/", options, timeout).forEach(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));
 

Parameters:

delimiter - The delimiter for blob hierarchy, "/" for hierarchy based on directories

options - ListBlobsOptions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

A reactive response emitting the prefixes and blobs.

getAccountInfo

public StorageAccountInfo getAccountInfo(Duration timeout)

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Code Samples

 StorageAccountInfo accountInfo = client.getAccountInfo(timeout);
 System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());
 

Returns:

The account info.

getAccountInfoWithResponse

public com.azure.core.http.rest.Response<StorageAccountInfo> getAccountInfoWithResponse(Duration timeout,
                                                                                        com.azure.core.util.Context context)

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Code Samples

 Context context = new Context("Key", "Value");
 StorageAccountInfo accountInfo = client.getAccountInfoWithResponse(timeout, context).getValue();
 System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());
 

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The account info.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues,
                                        UserDelegationKey userDelegationKey)

Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Code Samples

 OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission myPermission = new BlobContainerSasPermission().setReadPermission(true);
 
 BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());
 
 client.generateUserDelegationSas(values, userDelegationKey);
 

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values. See BlobServiceClient.getUserDelegationKey(OffsetDateTime, OffsetDateTime) for more information on how to get a user delegation key.

Returns:

A String representing the SAS query parameters.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues,
                                        UserDelegationKey userDelegationKey,
                                        String accountName,
                                        com.azure.core.util.Context context)

Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Code Samples

 OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission myPermission = new BlobContainerSasPermission().setReadPermission(true);
 
 BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());
 
 client.generateUserDelegationSas(values, userDelegationKey, accountName, new Context("key", "value"));
 

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values. See BlobServiceClient.getUserDelegationKey(OffsetDateTime, OffsetDateTime) for more information on how to get a user delegation key..

accountName - The account name.

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues)

Generates a service SAS for the container using the specified BlobServiceSasSignatureValues

Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Code Samples

 OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission permission = new BlobContainerSasPermission().setReadPermission(true);
 
 BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());
 
 client.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential
 

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

Returns:

A String representing the SAS query parameters.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues,
                          com.azure.core.util.Context context)

Generates a service SAS for the container using the specified BlobServiceSasSignatureValues

Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Code Samples

 OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission permission = new BlobContainerSasPermission().setReadPermission(true);
 
 BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());
 
 // Client must be authenticated via StorageSharedKeyCredential
 client.generateSas(values, new Context("key", "value"));
 

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.