BlobContainerAsyncClient Class

public static final String LOG_CONTAINER_NAME

Special container name for the logs container in the Storage account.

public static final String ROOT_CONTAINER_NAME

Special container name for the root container in the Storage account.

public static final String STATIC_WEBSITE_CONTAINER_NAME

Special container name for the static website container in the Storage account.

public Mono 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

client.create().subscribe(
     response -> System.out.printf("Create completed%n"),
     error -> System.out.printf("Error while creating container %s%n", error));

Returns:

public Mono createIfNotExists()

Creates a new container within a storage account if it does not exist. For more information, see the Azure Docs.

Code Samples

client.createIfNotExists().subscribe(created -> {
     if (created) {
         System.out.println("successfully created.");
     } else {
         System.out.println("Already exists.");
     }
 });

Returns:

public Mono> createIfNotExistsWithResponse(BlobContainerCreateOptions options)

Creates a new container within a storage account if it does not exist. For more information, see the Azure Docs.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 BlobContainerCreateOptions options = new BlobContainerCreateOptions().setMetadata(metadata)
     .setPublicAccessType(PublicAccessType.CONTAINER);

 client.createIfNotExistsWithResponse(options).subscribe(response -> {
     if (response.getStatusCode() == 409) {
         System.out.println("Already exists.");
     } else {
         System.out.println("successfully created.");
     }
 });

Parameters:

Returns:

public Mono> createWithResponse(Map metadata, PublicAccessType accessType)

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");
 client.createWithResponse(metadata, PublicAccessType.CONTAINER).subscribe(response ->
     System.out.printf("Create completed with status %d%n", response.getStatusCode()));

Parameters:

Returns:

public Mono 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

client.delete().subscribe(
     response -> System.out.printf("Delete completed%n"),
     error -> System.out.printf("Delete failed: %s%n", error));

Returns:

public Mono deleteIfExists()

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

Code Samples

client.deleteIfExists().subscribe(deleted -> {
     if (deleted) {
         System.out.println("Successfully deleted.");
     } else {
         System.out.println("Does not exist.");
     }
 });

Returns:

public Mono> deleteIfExistsWithResponse(BlobRequestConditions requestConditions)

Marks the specified container for deletion if it exists. 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));

 client.deleteIfExistsWithResponse(requestConditions).subscribe(response -> {
     if (response.getStatusCode() == 404) {
         System.out.println("Does not exist.");
     } else {
         System.out.println("successfully deleted.");
     }
 });

Parameters:

Returns:

public Mono> deleteWithResponse(BlobRequestConditions requestConditions)

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));

 client.deleteWithResponse(requestConditions).subscribe(response ->
     System.out.printf("Delete completed with status %d%n", response.getStatusCode()));

Parameters:

Returns:

public Mono exists()

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

Code Samples

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

Returns:

public Mono> existsWithResponse()

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

Code Samples

client.existsWithResponse().subscribe(response -> System.out.printf("Exists? %b%n", response.getValue()));

Returns:

public PagedFlux findBlobsByTags(FindBlobsOptions options)

Returns a reactive Publisher emitting the blobs in this container whose tags match the query expression. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

client.findBlobsByTags(new FindBlobsOptions("where=tag=value").setMaxResultsPerPage(10))
     .subscribe(blob -> System.out.printf("Name: %s%n", blob.getName()));

Parameters:

Returns:

public PagedFlux findBlobsByTags(String query)

Returns a reactive Publisher emitting the blobs in this container whose tags match the query expression. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

client.findBlobsByTags("where=tag=value").subscribe(blob -> System.out.printf("Name: %s%n", blob.getName()));

Parameters:

Returns:

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:

Returns:

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, 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:

Returns:

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, Consumer stringToSignHandler, 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.

Parameters:

Returns:

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:

Returns:

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, 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:

Returns:

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Consumer stringToSignHandler, 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.

Parameters:

Returns:

public Mono 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

client.getAccessPolicy().subscribe(response -> {
     System.out.printf("Blob Access Type: %s%n", response.getBlobAccessType());

     for (BlobSignedIdentifier identifier : response.getIdentifiers()) {
         System.out.printf("Identifier Name: %s, Permissions %s%n",
             identifier.getId(),
             identifier.getAccessPolicy().getPermissions());
     }
 });

Returns:

public Mono> getAccessPolicyWithResponse(String leaseId)

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

client.getAccessPolicyWithResponse(leaseId).subscribe(response -> {
     System.out.printf("Blob Access Type: %s%n", response.getValue().getBlobAccessType());

     for (BlobSignedIdentifier identifier : response.getValue().getIdentifiers()) {
         System.out.printf("Identifier Name: %s, Permissions %s%n",
             identifier.getId(),
             identifier.getAccessPolicy().getPermissions());
     }
 });

Parameters:

Returns:

public Mono getAccountInfo()

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

Code Samples

client.getAccountInfo().subscribe(response ->
     System.out.printf("Account Kind: %s, SKU: %s%n",
         response.getAccountKind(),
         response.getSkuName()));

Returns:

public Mono> getAccountInfoWithResponse()

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

Code Samples

client.getAccountInfoWithResponse().subscribe(response ->
     System.out.printf("Account Kind: %s, SKU: %s%n",
         response.getValue().getAccountKind(),
         response.getValue().getSkuName()));

Returns:

public String getAccountName()

Get associated account name.

Returns:

public String getAccountUrl()

Get the url of the storage account.

Returns:

public BlobAsyncClient getBlobAsyncClient(String blobName)

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

Code Samples

BlobAsyncClient blobAsyncClient = client.getBlobAsyncClient(blobName);

Parameters:

Returns:

public BlobAsyncClient getBlobAsyncClient(String blobName, String snapshot)

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

Code Samples

BlobAsyncClient blobAsyncClient = client.getBlobAsyncClient(blobName, snapshot);

Parameters:

Returns:

public String getBlobContainerName()

Get the container name.

Code Samples

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

Returns:

public String getBlobContainerUrl()

Gets the URL of the container represented by this client.

Returns:

public BlobAsyncClient getBlobVersionAsyncClient(String blobName, String versionId)

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

Parameters:

Returns:

public CpkInfo getCustomerProvidedKey()

Gets the CpkInfo associated with this client that will be passed to BlobAsyncClient when getBlobAsyncClient(String blobName) is called.

Returns:

public String getEncryptionScope()

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

Returns:

public HttpPipeline getHttpPipeline()

Gets the HttpPipeline powering this client.

Returns:

public Mono getProperties()

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

Code Samples

client.getProperties().subscribe(response ->
     System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
         response.getBlobPublicAccess(),
         response.hasLegalHold(),
         response.hasImmutabilityPolicy()));

Returns:

public Mono> getPropertiesWithResponse(String leaseId)

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

Code Samples

client.getPropertiesWithResponse(leaseId).subscribe(response ->
     System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
         response.getValue().getBlobPublicAccess(),
         response.getValue().hasLegalHold(),
         response.getValue().hasImmutabilityPolicy()));

Parameters:

Returns:

public BlobServiceAsyncClient getServiceAsyncClient()

Get an async client pointing to the account.

Returns:

public BlobServiceVersion getServiceVersion()

Gets the service version the client is using.

Returns:

public PagedFlux listBlobs()

Returns a reactive Publisher emitting all the blobs in this container lazily as needed. The directories are flattened and only actual blobs and no directories are returned.

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

• foo/foo1
• foo/foo2
• bar

Code Samples

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

Returns:

public PagedFlux listBlobs(ListBlobsOptions options)

Returns a reactive Publisher emitting all the blobs in this container lazily as needed. The directories are flattened and only actual blobs and no directories are returned.

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

• foo/foo1
• foo/foo2
• bar

ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));

 client.listBlobs(options).subscribe(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));

Parameters:

Returns:

public PagedFlux listBlobs(ListBlobsOptions options, String continuationToken)

Returns a reactive Publisher emitting all the blobs in this container lazily as needed. The directories are flattened and only actual blobs and no directories are returned.

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

• foo/foo1
• foo/foo2
• bar

ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));

 String continuationToken = "continuationToken";

 client.listBlobs(options, continuationToken).subscribe(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));

Parameters:

Returns:

public PagedFlux listBlobsByHierarchy(String directory)

Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix). Directories will have 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").subscribe(blob ->
     System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isDeleted()));

Parameters:

Returns:

public PagedFlux listBlobsByHierarchy(String delimiter, ListBlobsOptions options)

Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory). Directories will have 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).subscribe(blob ->
     System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
         blob.getName(),
         blob.isPrefix(),
         blob.isDeleted(),
         blob.getSnapshot()));

Parameters:

Returns:

public Mono setAccessPolicy(PublicAccessType accessType, List 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"));

 client.setAccessPolicy(PublicAccessType.CONTAINER, Collections.singletonList(identifier)).subscribe(
     response -> System.out.printf("Set access policy completed%n"),
     error -> System.out.printf("Set access policy failed: %s%n", error));

Parameters:

Returns:

public Mono> setAccessPolicyWithResponse(PublicAccessType accessType, List identifiers, BlobRequestConditions requestConditions)

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));

 client.setAccessPolicyWithResponse(PublicAccessType.CONTAINER, Collections.singletonList(identifier), requestConditions)
     .subscribe(response ->
         System.out.printf("Set access policy completed with status %d%n", response.getStatusCode()));

Parameters:

Returns:

public Mono setMetadata(Map metadata)

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

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 client.setMetadata(metadata).subscribe(
     response -> System.out.printf("Set metadata completed%n"),
     error -> System.out.printf("Set metadata failed: %s%n", error));

Parameters:

Returns:

public Mono> setMetadataWithResponse(Map metadata, BlobRequestConditions requestConditions)

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));

 client.setMetadataWithResponse(metadata, requestConditions).subscribe(response ->
     System.out.printf("Set metadata completed with status %d%n", response.getStatusCode()));

Parameters:

Returns: