BlobServiceClient Class

public BlobContainerClient createBlobContainer(String containerName)

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

BlobContainerClient blobContainerClient = client.createBlobContainer("containerName");

Parameters:

Returns:

public BlobContainerClient createBlobContainerIfNotExists(String containerName)

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

Code Samples

BlobContainerClient blobContainerClient = client.createBlobContainerIfNotExists("containerName");

Parameters:

Returns:

public Response createBlobContainerIfNotExistsWithResponse(String containerName, BlobContainerCreateOptions options, Context context)

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");
 Context context = new Context("Key", "Value");
 BlobContainerCreateOptions options = new BlobContainerCreateOptions().setMetadata(metadata)
     .setPublicAccessType(PublicAccessType.CONTAINER);

 Response<BlobContainerClient> response = client.createBlobContainerIfNotExistsWithResponse("containerName",
     options, context);

 if (response.getStatusCode() == 409) {
     System.out.println("Already existed.");
 } else {
     System.out.printf("Create completed with status %d%n", response.getStatusCode());
 }

Parameters:

Returns:

public Response createBlobContainerWithResponse(String containerName, Map metadata, PublicAccessType accessType, 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");

 BlobContainerClient blobContainerClient = client.createBlobContainerWithResponse(
     "containerName",
     metadata,
     PublicAccessType.CONTAINER,
     context).getValue();

Parameters:

Returns:

public void deleteBlobContainer(String containerName)

Deletes the specified container in the storage account. If the container doesn't exist the operation fails. For more information see the Azure Docs.

Code Samples

try {
     client.deleteBlobContainer("container Name");
     System.out.printf("Delete container completed with status %n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Delete container failed: %s%n", error);
 }

Parameters:

public boolean deleteBlobContainerIfExists(String containerName)

Deletes the specified container in the storage account if it exists. For more information see the Azure Docs.

Code Samples

boolean result = client.deleteBlobContainerIfExists("container Name");
 System.out.println("Delete container completed: " + result);

Parameters:

Returns:

public Response deleteBlobContainerIfExistsWithResponse(String containerName, Context context)

Deletes the specified container in the storage account if it exists. For more information see the Azure Docs.

Code Samples

Context context = new Context("Key", "Value");

 Response<Boolean> response = client.deleteBlobContainerIfExistsWithResponse("containerName", context);
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

Parameters:

Returns:

public Response deleteBlobContainerWithResponse(String containerName, Context context)

Deletes the specified container in the storage account. If the container doesn't exist the operation fails. For more information see the Azure Docs.

Parameters:

Returns:

public PagedIterable findBlobsByTags(FindBlobsOptions options, Duration timeout, Context context)

Returns a lazy loaded list of blobs in this account whose tags match the query expression. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

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

Parameters:

Returns:

public PagedIterable findBlobsByTags(String query)

Returns a lazy loaded list of blobs in this account whose tags match the query expression. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

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

Parameters:

Returns:

public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)

Generates an account SAS for the Azure Storage account using the specified AccountSasSignatureValues.

Note : The client must be authenticated via StorageSharedKeyCredential

See AccountSasSignatureValues for more information on how to construct an account SAS.

Generating an account SAS

The snippet below generates an AccountSasSignatureValues object that lasts for two days and gives the user read and list access to blob and file shares.

AccountSasPermission permissions = new AccountSasPermission()
     .setListPermission(true)
     .setReadPermission(true);
 AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);
 AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);
 OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));

 AccountSasSignatureValues sasValues =
     new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);

 // Client must be authenticated via StorageSharedKeyCredential
 String sas = client.generateAccountSas(sasValues);

Parameters:

Returns:

public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)

Generates an account SAS for the Azure Storage account using the specified AccountSasSignatureValues.

Note : The client must be authenticated via StorageSharedKeyCredential

See AccountSasSignatureValues for more information on how to construct an account SAS.

Generating an account SAS

The snippet below generates an AccountSasSignatureValues object that lasts for two days and gives the user read and list access to blob and file shares.

AccountSasPermission permissions = new AccountSasPermission()
     .setListPermission(true)
     .setReadPermission(true);
 AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);
 AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);
 OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));

 AccountSasSignatureValues sasValues =
     new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);

 // Client must be authenticated via StorageSharedKeyCredential
 String sas = client.generateAccountSas(sasValues, new Context("key", "value"));

Parameters:

Returns:

public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Consumer stringToSignHandler, Context context)

Generates an account SAS for the Azure Storage account using the specified AccountSasSignatureValues.

Note : The client must be authenticated via StorageSharedKeyCredential

See AccountSasSignatureValues for more information on how to construct an account SAS.

Parameters:

Returns:

public StorageAccountInfo getAccountInfo()

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

Code Samples

StorageAccountInfo accountInfo = client.getAccountInfo();

 System.out.printf("Account kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());

Returns:

public Response getAccountInfoWithResponse(Duration timeout, Context context)

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

Parameters:

Returns:

public String getAccountName()

Get associated account name.

Returns:

public String getAccountUrl()

Gets the URL of the storage account represented by this client.

Returns:

public BlobContainerClient getBlobContainerClient(String containerName)

Initializes a BlobContainerClient object pointing to the specified container. This method does not create a container. It simply constructs the URL to the container and offers access to methods relevant to containers.

Code Samples

BlobContainerClient blobContainerClient = client.getBlobContainerClient("containerName");

Parameters:

Returns:

public HttpPipeline getHttpPipeline()

Gets the HttpPipeline powering this client.

Returns:

public BlobServiceProperties getProperties()

Gets the properties of a storage account\u2019s Blob service. For more information, see the Azure Docs.

Code Samples

BlobServiceProperties properties = client.getProperties();

 System.out.printf("Hour metrics enabled: %b, Minute metrics enabled: %b%n",
     properties.getHourMetrics().isEnabled(),
     properties.getMinuteMetrics().isEnabled());

Returns:

public Response getPropertiesWithResponse(Duration timeout, Context context)

Gets the properties of a storage account\u2019s Blob service. For more information, see the Azure Docs.

Code Samples

Context context = new Context("Key", "Value");
 BlobServiceProperties properties = client.getPropertiesWithResponse(timeout, context).getValue();

 System.out.printf("Hour metrics enabled: %b, Minute metrics enabled: %b%n",
     properties.getHourMetrics().isEnabled(),
     properties.getMinuteMetrics().isEnabled());

Parameters:

Returns:

public BlobServiceVersion getServiceVersion()

Gets the service version the client is using.

Returns:

public BlobServiceStatistics getStatistics()

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the Azure Docs.

Code Samples

System.out.printf("Geo-replication status: %s%n",
     client.getStatistics().getGeoReplication().getStatus());

Returns:

public Response getStatisticsWithResponse(Duration timeout, Context context)

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the Azure Docs.

Code Samples

System.out.printf("Geo-replication status: %s%n",
     client.getStatisticsWithResponse(timeout, context).getValue().getGeoReplication().getStatus());

Parameters:

Returns:

public UserDelegationKey getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)

Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using TokenCredential in this object's HttpPipeline.

Code Samples

System.out.printf("User delegation key: %s%n",
     client.getUserDelegationKey(delegationKeyStartTime, delegationKeyExpiryTime));

Parameters:

Returns:

public Response getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry, Duration timeout, Context context)

Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using TokenCredential in this object's HttpPipeline.

Code Samples

System.out.printf("User delegation key: %s%n",
     client.getUserDelegationKeyWithResponse(delegationKeyStartTime, delegationKeyExpiryTime, timeout, context));

Parameters:

Returns:

public PagedIterable listBlobContainers()

Returns a lazy loaded list of containers in this account. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, see the Azure Docs.

Code Samples

client.listBlobContainers().forEach(container -> System.out.printf("Name: %s%n", container.getName()));

Returns:

public PagedIterable listBlobContainers(ListBlobContainersOptions options, Duration timeout)

Returns a lazy loaded list of containers in this account. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, see the Azure Docs.

Code Samples

ListBlobContainersOptions options = new ListBlobContainersOptions()
     .setPrefix("containerNamePrefixToMatch")
     .setDetails(new BlobContainerListDetails().setRetrieveMetadata(true));

 client.listBlobContainers(options, timeout).forEach(container -> System.out.printf("Name: %s%n", container.getName()));

Parameters:

Returns:

public void setProperties(BlobServiceProperties properties)

Sets properties for a storage account's Blob service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.

This method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.

Code Samples

BlobRetentionPolicy loggingRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(3);
 BlobRetentionPolicy metricsRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(1);

 BlobServiceProperties properties = new BlobServiceProperties()
     .setLogging(new BlobAnalyticsLogging()
         .setWrite(true)
         .setDelete(true)
         .setVersion("1.0")
         .setRetentionPolicy(loggingRetentionPolicy))
     .setHourMetrics(new BlobMetrics()
         .setEnabled(true)
         .setVersion("1.0")
         .setIncludeApis(true)
         .setRetentionPolicy(metricsRetentionPolicy))
     .setMinuteMetrics(new BlobMetrics()
         .setEnabled(true)
         .setVersion("1.0")
         .setIncludeApis(true)
         .setRetentionPolicy(metricsRetentionPolicy));

 try {
     client.setProperties(properties);
     System.out.printf("Setting properties completed%n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Setting properties failed: %s%n", error);
 }

Parameters:

public Response setPropertiesWithResponse(BlobServiceProperties properties, Duration timeout, Context context)

Sets properties for a storage account's Blob service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.

This method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.

Code Samples

BlobRetentionPolicy loggingRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(3);
 BlobRetentionPolicy metricsRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(1);

 BlobServiceProperties properties = new BlobServiceProperties()
     .setLogging(new BlobAnalyticsLogging()
         .setWrite(true)
         .setDelete(true)
         .setVersion("1.0")
         .setRetentionPolicy(loggingRetentionPolicy))
     .setHourMetrics(new BlobMetrics()
         .setEnabled(true)
         .setVersion("1.0")
         .setIncludeApis(true)
         .setRetentionPolicy(metricsRetentionPolicy))
     .setMinuteMetrics(new BlobMetrics()
         .setEnabled(true)
         .setVersion("1.0")
         .setIncludeApis(true)
         .setRetentionPolicy(metricsRetentionPolicy));

 Context context = new Context("Key", "Value");

 System.out.printf("Setting properties completed with status %d%n",
     client.setPropertiesWithResponse(properties, timeout, context).getStatusCode());

Parameters:

Returns:

public BlobContainerClient undeleteBlobContainer(String deletedContainerName, String deletedContainerVersion)

Restores a previously deleted container. If the container associated with provided deletedContainerName already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.

Code Samples

ListBlobContainersOptions listBlobContainersOptions = new ListBlobContainersOptions();
 listBlobContainersOptions.getDetails().setRetrieveDeleted(true);
 client.listBlobContainers(listBlobContainersOptions, null).forEach(
     deletedContainer -> {
         BlobContainerClient blobContainerClient = client.undeleteBlobContainer(
             deletedContainer.getName(), deletedContainer.getVersion());
     }
 );

Parameters:

Returns:

public Response undeleteBlobContainerWithResponse(UndeleteBlobContainerOptions options, Duration timeout, Context context)

Restores a previously deleted container. The restored container will be renamed to the destinationContainerName if provided in options. Otherwise deletedContainerName is used as destination container name. If the container associated with provided destinationContainerName already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.

Code Samples

ListBlobContainersOptions listBlobContainersOptions = new ListBlobContainersOptions();
 listBlobContainersOptions.getDetails().setRetrieveDeleted(true);
 client.listBlobContainers(listBlobContainersOptions, null).forEach(
     deletedContainer -> {
         BlobContainerClient blobContainerClient = client.undeleteBlobContainerWithResponse(
             new UndeleteBlobContainerOptions(deletedContainer.getName(), deletedContainer.getVersion()),
             timeout, context).getValue();
     }
 );

Parameters:

Returns: