Package com.azure.storage.blob.specialized

Class BlobClientBase

    • Method Detail

      • getSnapshotClient

        public BlobClientBase getSnapshotClient​(String snapshot)
        Creates a new BlobClientBase linked to the snapshot of this blob resource.
        Parameters:
        snapshot - the identifier for a specific snapshot of this blob
        Returns:
        a BlobClientBase used to interact with the specific snapshot.

      • getVersionClient

        public BlobClientBase getVersionClient​(String versionId)
        Creates a new BlobClientBase linked to the version of this blob resource.
        Parameters:
        versionId - the identifier for a specific version of this blob, pass null to interact with the latest blob version.
        Returns:
        a BlobClientBase used to interact with the specific version.

      • getEncryptionScopeClient

        public BlobClientBase getEncryptionScopeClient​(String encryptionScope)
        Creates a new BlobClientBase with the specified encryptionScope.
        Parameters:
        encryptionScope - the encryption scope for the blob, pass null to use no encryption scope.
        Returns:
        a BlobClientBase with the specified encryptionScope.

      • getAccountUrl

        public String getAccountUrl()
        Get the url of the storage account.
        Returns:
        the URL of the storage account

      • getBlobUrl

        public String getBlobUrl()
        Gets the URL of the blob represented by this client.
        Returns:
        the URL.

      • getAccountName

        public String getAccountName()
        Get associated account name.
        Returns:
        account name associated with this storage resource.

      • getContainerName

        public final String getContainerName()
        Get the container name.

        Code Samples

         String containerName = client.getContainerName();
 System.out.println("The name of the container is " + containerName);
        Returns:
        The name of the container.

      • getContainerClient

        public BlobContainerClient getContainerClient()
        Gets a client pointing to the parent container.

        Code Samples

         BlobContainerClient containerClient = client.getContainerClient();
 System.out.println("The name of the container is " + containerClient.getBlobContainerName());
        Returns:
        BlobContainerClient

      • getBlobName

        public final String getBlobName()
        Decodes and gets the blob name.

        Code Samples

         String blobName = client.getBlobName();
 System.out.println("The name of the blob is " + blobName);
        Returns:
        The decoded name of the blob.

      • getHttpPipeline

        public com.azure.core.http.HttpPipeline getHttpPipeline()
        Gets the HttpPipeline powering this client.
        Returns:
        The pipeline.

      • getCustomerProvidedKey

        public CpkInfo getCustomerProvidedKey()
        Gets the CpkInfo used to encrypt this blob's content on the server.
        Returns:
        the customer provided key used for encryption.

      • getServiceVersion

        public BlobServiceVersion getServiceVersion()
        Gets the service version the client is using.
        Returns:
        the service version the client is using.

      • getSnapshotId

        public String getSnapshotId()
        Gets the snapshotId for a blob resource
        Returns:
        A string that represents the snapshotId of the snapshot blob

      • getVersionId

        public String getVersionId()
        Gets the versionId for a blob resource
        Returns:
        A string that represents the versionId of the snapshot blob

      • isSnapshot

        public boolean isSnapshot()
        Determines if a blob is a snapshot
        Returns:
        A boolean that indicates if a blob is a snapshot

      • openInputStream

        public final BlobInputStream openInputStream()
        Opens a blob input stream to download the blob.

        Returns:
        An InputStream object that represents the stream to use for reading from the blob.
        Throws:
        BlobStorageException - If a storage service error occurred.

      • openInputStream

        public final BlobInputStream openInputStream​(BlobRange range,
                                             BlobRequestConditions requestConditions)
        Opens a blob input stream to download the specified range of the blob.

        Parameters:
        range - BlobRange
        requestConditions - An BlobRequestConditions object that represents the access conditions for the blob.
        Returns:
        An InputStream object that represents the stream to use for reading from the blob.
        Throws:
        BlobStorageException - If a storage service error occurred.

      • exists

        public Boolean exists()
        Gets if the blob this client represents exists in the cloud.

        Code Samples

         System.out.printf("Exists? %b%n", client.exists());
        Returns:
        true if the blob 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 blob this client represents exists in the cloud.

        Code Samples

         System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, new Context(key2, value2)).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 blob exists, false if it doesn't

      • beginCopy

        public com.azure.core.util.polling.SyncPoller<BlobCopyInfo,​Void> beginCopy​(String sourceUrl,
                                                                                 Duration pollInterval)
        Copies the data at the source URL to a blob.

        This method triggers a long-running, asynchronous operations. The source may be another blob or an Azure File. If the source is in another account, the source must either be public or authenticated with a SAS token. If the source is in the same account, the Shared Key authorization on the destination will also be applied to the source. The source URL must be URL encoded.

        Code Samples

         final SyncPoller<BlobCopyInfo, Void> poller = client.beginCopy(url, Duration.ofSeconds(2));
 PollResponse<BlobCopyInfo> pollResponse = poller.poll();
 System.out.printf("Copy identifier: %s%n", pollResponse.getValue().getCopyId());

        For more information, see the Azure Docs

        Parameters:
        sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
        pollInterval - Duration between each poll for the copy status. If none is specified, a default of one second is used.
        Returns:
        A SyncPoller to poll the progress of blob copy operation.

      • beginCopy

        public com.azure.core.util.polling.SyncPoller<BlobCopyInfo,​Void> beginCopy​(String sourceUrl,
                                                                                 Map<String,​String> metadata,
                                                                                 AccessTier tier,
                                                                                 RehydratePriority priority,
                                                                                 com.azure.core.http.RequestConditions sourceModifiedRequestConditions,
                                                                                 BlobRequestConditions destRequestConditions,
                                                                                 Duration pollInterval)
        Copies the data at the source URL to a blob.

        This method triggers a long-running, asynchronous operations. The source may be another blob or an Azure File. If the source is in another account, the source must either be public or authenticated with a SAS token. If the source is in the same account, the Shared Key authorization on the destination will also be applied to the source. The source URL must be URL encoded.

        Code Samples

         Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 RequestConditions modifiedRequestConditions = new RequestConditions()
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
 BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);
 SyncPoller<BlobCopyInfo, Void> poller = client.beginCopy(url, metadata, AccessTier.HOT,
     RehydratePriority.STANDARD, modifiedRequestConditions, blobRequestConditions, Duration.ofSeconds(2));

 PollResponse<BlobCopyInfo> response = poller.waitUntil(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED);
 System.out.printf("Copy identifier: %s%n", response.getValue().getCopyId());

        For more information, see the Azure Docs

        Parameters:
        sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
        metadata - Metadata to associate with the destination blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.
        tier - AccessTier for the destination blob.
        priority - RehydratePriority for rehydrating the blob.
        sourceModifiedRequestConditions - RequestConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.
        destRequestConditions - BlobRequestConditions against the destination.
        pollInterval - Duration between each poll for the copy status. If none is specified, a default of one second is used.
        Returns:
        A SyncPoller to poll the progress of blob copy operation.

      • beginCopy

        public com.azure.core.util.polling.SyncPoller<BlobCopyInfo,​Void> beginCopy​(BlobBeginCopyOptions options)
        Copies the data at the source URL to a blob.

        This method triggers a long-running, asynchronous operations. The source may be another blob or an Azure File. If the source is in another account, the source must either be public or authenticated with a SAS token. If the source is in the same account, the Shared Key authorization on the destination will also be applied to the source. The source URL must be URL encoded.

        Code Samples

         Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 Map<String, String> tags = Collections.singletonMap("tag", "value");
 BlobBeginCopySourceRequestConditions modifiedRequestConditions = new BlobBeginCopySourceRequestConditions()
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
 BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);
 SyncPoller<BlobCopyInfo, Void> poller = client.beginCopy(new BlobBeginCopyOptions(url).setMetadata(metadata)
     .setTags(tags).setTier(AccessTier.HOT).setRehydratePriority(RehydratePriority.STANDARD)
     .setSourceRequestConditions(modifiedRequestConditions)
     .setDestinationRequestConditions(blobRequestConditions).setPollInterval(Duration.ofSeconds(2)));

 PollResponse<BlobCopyInfo> response = poller.waitUntil(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED);
 System.out.printf("Copy identifier: %s%n", response.getValue().getCopyId());

        For more information, see the Azure Docs

        Parameters:
        options - BlobBeginCopyOptions
        Returns:
        A SyncPoller to poll the progress of blob copy operation.

      • abortCopyFromUrl

        public void abortCopyFromUrl​(String copyId)
        Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.

        Code Samples

         client.abortCopyFromUrl(copyId);
 System.out.println("Aborted copy completed.");

        For more information, see the Azure Docs

        Parameters:
        copyId - The id of the copy operation to abort.

      • abortCopyFromUrlWithResponse

        public com.azure.core.http.rest.Response<Void> abortCopyFromUrlWithResponse​(String copyId,
                                                                            String leaseId,
                                                                            Duration timeout,
                                                                            com.azure.core.util.Context context)
        Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.

        Code Samples

         System.out.printf("Aborted copy completed with status %d%n",
     client.abortCopyFromUrlWithResponse(copyId, leaseId, timeout,
         new Context(key2, value2)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        copyId - The id of the copy operation to abort.
        leaseId - The lease ID the active lease on the blob 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:
        A response containing status code and HTTP headers.

      • copyFromUrl

        public String copyFromUrl​(String copySource)
        Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.

        The source must be a block blob no larger than 256MB. The source must also be either public or have a sas token attached. The URL must be URL encoded.

        Code Samples

         System.out.printf("Copy identifier: %s%n", client.copyFromUrl(url));

        For more information, see the Azure Docs

        Parameters:
        copySource - The source URL to copy from.
        Returns:
        The copy ID for the long running operation.
        Throws:
        IllegalArgumentException - If copySource is a malformed URL.

      • copyFromUrlWithResponse

        public com.azure.core.http.rest.Response<String> copyFromUrlWithResponse​(String copySource,
                                                                         Map<String,​String> metadata,
                                                                         AccessTier tier,
                                                                         com.azure.core.http.RequestConditions sourceModifiedRequestConditions,
                                                                         BlobRequestConditions destRequestConditions,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)
        Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.

        The source must be a block blob no larger than 256MB. The source must also be either public or have a sas token attached. The URL must be URL encoded.

        Code Samples

         Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 RequestConditions modifiedRequestConditions = new RequestConditions()
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
 BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 System.out.printf("Copy identifier: %s%n",
     client.copyFromUrlWithResponse(url, metadata, AccessTier.HOT, modifiedRequestConditions,
         blobRequestConditions, timeout,
         new Context(key1, value1)).getValue());

        For more information, see the Azure Docs

        Parameters:
        copySource - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
        metadata - Metadata to associate with the destination blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.
        tier - AccessTier for the destination blob.
        sourceModifiedRequestConditions - RequestConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.
        destRequestConditions - BlobRequestConditions against the destination.
        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 copy ID for the long running operation.
        Throws:
        IllegalArgumentException - If copySource is a malformed URL.

      • copyFromUrlWithResponse

        public com.azure.core.http.rest.Response<String> copyFromUrlWithResponse​(BlobCopyFromUrlOptions options,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)
        Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.

        The source must be a block blob no larger than 256MB. The source must also be either public or have a sas token attached. The URL must be URL encoded.

        Code Samples

         Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 Map<String, String> tags = Collections.singletonMap("tag", "value");
 RequestConditions modifiedRequestConditions = new RequestConditions()
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
 BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 System.out.printf("Copy identifier: %s%n",
     client.copyFromUrlWithResponse(new BlobCopyFromUrlOptions(url).setMetadata(metadata).setTags(tags)
         .setTier(AccessTier.HOT).setSourceRequestConditions(modifiedRequestConditions)
         .setDestinationRequestConditions(blobRequestConditions), timeout,
         new Context(key1, value1)).getValue());

        For more information, see the Azure Docs

        Parameters:
        options - BlobCopyFromUrlOptions
        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 copy ID for the long running operation.
        Throws:
        IllegalArgumentException - If copySource is a malformed URL.

      • downloadContent

        public com.azure.core.util.BinaryData downloadContent()
        Downloads the entire blob. Uploading data must be done from the BlockBlobClient, PageBlobClient, or AppendBlobClient.

        Code Samples

         BinaryData data = client.downloadContent();
 System.out.printf("Downloaded %s", data.toString());

        For more information, see the Azure Docs

        This method supports downloads up to 2GB of data. Use downloadStream(OutputStream) to download larger blobs.

        Returns:
        The content of the blob.
        Throws:
        UncheckedIOException - If an I/O error occurs.

      • downloadStreamWithResponse

        public BlobDownloadResponse downloadStreamWithResponse​(OutputStream stream,
                                                       BlobRange range,
                                                       DownloadRetryOptions options,
                                                       BlobRequestConditions requestConditions,
                                                       boolean getRangeContentMd5,
                                                       Duration timeout,
                                                       com.azure.core.util.Context context)
        Downloads a range of bytes from a blob into an output stream. Uploading data must be done from the BlockBlobClient, PageBlobClient, or AppendBlobClient.

        Code Samples

         BlobRange range = new BlobRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);

 System.out.printf("Download completed with status %d%n",
     client.downloadStreamWithResponse(new ByteArrayOutputStream(), range, options, null, false,
         timeout, new Context(key2, value2)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        stream - A non-null OutputStream instance where the downloaded data will be written.
        range - BlobRange
        options - DownloadRetryOptions
        requestConditions - BlobRequestConditions
        getRangeContentMd5 - Whether the contentMD5 for the specified blob range should be returned.
        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.
        Throws:
        UncheckedIOException - If an I/O error occurs.
        NullPointerException - if stream is null

      • downloadToFile

        public BlobProperties downloadToFile​(String filePath)
        Downloads the entire blob into a file specified by the path.

        The file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

        Code Samples

         client.downloadToFile(file);
 System.out.println("Completed download to file");

        For more information, see the Azure Docs

        Parameters:
        filePath - A String representing the filePath where the downloaded data will be written.
        Returns:
        The blob properties and metadata.
        Throws:
        UncheckedIOException - If an I/O error occurs

      • downloadToFile

        public BlobProperties downloadToFile​(String filePath,
                                     boolean overwrite)
        Downloads the entire blob into a file specified by the path.

        If overwrite is set to false, the file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

        Code Samples

         boolean overwrite = false; // Default value
 client.downloadToFile(file, overwrite);
 System.out.println("Completed download to file");

        For more information, see the Azure Docs

        Parameters:
        filePath - A String representing the filePath where the downloaded data will be written.
        overwrite - Whether or not to overwrite the file, should the file exist.
        Returns:
        The blob properties and metadata.
        Throws:
        UncheckedIOException - If an I/O error occurs

      • downloadToFileWithResponse

        public com.azure.core.http.rest.Response<BlobProperties> downloadToFileWithResponse​(String filePath,
                                                                                    BlobRange range,
                                                                                    ParallelTransferOptions parallelTransferOptions,
                                                                                    DownloadRetryOptions downloadRetryOptions,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    boolean rangeGetContentMd5,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)
        Downloads the entire blob into a file specified by the path.

        The file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

        Code Samples

         BlobRange range = new BlobRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);

 client.downloadToFileWithResponse(file, range, new ParallelTransferOptions().setBlockSizeLong(4L * Constants.MB),
     options, null, false, timeout, new Context(key2, value2));
 System.out.println("Completed download to file");

        For more information, see the Azure Docs

        Parameters:
        filePath - A String representing the filePath where the downloaded data will be written.
        range - BlobRange
        parallelTransferOptions - ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.
        downloadRetryOptions - DownloadRetryOptions
        requestConditions - BlobRequestConditions
        rangeGetContentMd5 - Whether the contentMD5 for the specified blob range should be returned.
        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 the blob properties and metadata.
        Throws:
        UncheckedIOException - If an I/O error occurs.

      • downloadToFileWithResponse

        public com.azure.core.http.rest.Response<BlobProperties> downloadToFileWithResponse​(String filePath,
                                                                                    BlobRange range,
                                                                                    ParallelTransferOptions parallelTransferOptions,
                                                                                    DownloadRetryOptions downloadRetryOptions,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    boolean rangeGetContentMd5,
                                                                                    Set<OpenOption> openOptions,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)
        Downloads the entire blob into a file specified by the path.

        By default the file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown. To override this behavior, provide appropriate OpenOptions

        Code Samples

         BlobRange blobRange = new BlobRange(1024, 2048L);
 DownloadRetryOptions downloadRetryOptions = new DownloadRetryOptions().setMaxRetryRequests(5);
 Set<OpenOption> openOptions = new HashSet<>(Arrays.asList(StandardOpenOption.CREATE_NEW,
     StandardOpenOption.WRITE, StandardOpenOption.READ)); // Default options

 client.downloadToFileWithResponse(file, blobRange, new ParallelTransferOptions().setBlockSizeLong(4L * Constants.MB),
     downloadRetryOptions, null, false, openOptions, timeout, new Context(key2, value2));
 System.out.println("Completed download to file");

        For more information, see the Azure Docs

        Parameters:
        filePath - A String representing the filePath where the downloaded data will be written.
        range - BlobRange
        parallelTransferOptions - ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.
        downloadRetryOptions - DownloadRetryOptions
        requestConditions - BlobRequestConditions
        rangeGetContentMd5 - Whether the contentMD5 for the specified blob range should be returned.
        openOptions - OpenOptions to use to configure how to open or create the file.
        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 the blob properties and metadata.
        Throws:
        UncheckedIOException - If an I/O error occurs.

      • downloadToFileWithResponse

        public com.azure.core.http.rest.Response<BlobProperties> downloadToFileWithResponse​(BlobDownloadToFileOptions options,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)
        Downloads the entire blob into a file specified by the path.

        By default the file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown. To override this behavior, provide appropriate OpenOptions

        Code Samples

         client.downloadToFileWithResponse(new BlobDownloadToFileOptions(file)
     .setRange(new BlobRange(1024, 2018L))
     .setDownloadRetryOptions(new DownloadRetryOptions().setMaxRetryRequests(5))
     .setOpenOptions(new HashSet<>(Arrays.asList(StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE,
         StandardOpenOption.READ))), timeout, new Context(key2, value2));
 System.out.println("Completed download to file");

        For more information, see the Azure Docs

        Parameters:
        options - BlobDownloadToFileOptions
        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 the blob properties and metadata.
        Throws:
        UncheckedIOException - If an I/O error occurs.

      • deleteWithResponse

        public com.azure.core.http.rest.Response<Void> deleteWithResponse​(DeleteSnapshotsOptionType deleteBlobSnapshotOptions,
                                                                  BlobRequestConditions requestConditions,
                                                                  Duration timeout,
                                                                  com.azure.core.util.Context context)
        Deletes the specified blob or snapshot. To delete a blob with its snapshots use deleteWithResponse(DeleteSnapshotsOptionType, BlobRequestConditions, Duration, Context) and set DeleteSnapshotsOptionType to INCLUDE.

        Code Samples

         System.out.printf("Delete completed with status %d%n",
     client.deleteWithResponse(DeleteSnapshotsOptionType.INCLUDE, null, timeout,
         new Context(key1, value1)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        deleteBlobSnapshotOptions - Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null.
        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 BlobProperties getProperties()
        Returns the blob's metadata and properties.

        Code Samples

         BlobProperties properties = client.getProperties();
 System.out.printf("Type: %s, Size: %d%n", properties.getBlobType(), properties.getBlobSize());

        For more information, see the Azure Docs

        Returns:
        The blob properties and metadata.

      • getPropertiesWithResponse

        public com.azure.core.http.rest.Response<BlobProperties> getPropertiesWithResponse​(BlobRequestConditions requestConditions,
                                                                                   Duration timeout,
                                                                                   com.azure.core.util.Context context)
        Returns the blob's metadata and properties.

        Code Samples

         BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 BlobProperties properties = client.getPropertiesWithResponse(requestConditions, timeout,
     new Context(key2, value2)).getValue();
 System.out.printf("Type: %s, Size: %d%n", properties.getBlobType(), properties.getBlobSize());

        For more information, see the Azure Docs

        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:
        The blob properties and metadata.

      • setHttpHeaders

        public void setHttpHeaders​(BlobHttpHeaders headers)
        Changes a blob's HTTP header properties. if only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.

        Code Samples

         client.setHttpHeaders(new BlobHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary"));
 System.out.println("Set HTTP headers completed");

        For more information, see the Azure Docs

        Parameters:
        headers - BlobHttpHeaders

      • setHttpHeadersWithResponse

        public com.azure.core.http.rest.Response<Void> setHttpHeadersWithResponse​(BlobHttpHeaders headers,
                                                                          BlobRequestConditions requestConditions,
                                                                          Duration timeout,
                                                                          com.azure.core.util.Context context)
        Changes a blob's HTTP header properties. if only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.

        Code Samples

         BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 System.out.printf("Set HTTP headers completed with status %d%n",
     client.setHttpHeadersWithResponse(new BlobHttpHeaders()
         .setContentLanguage("en-US")
         .setContentType("binary"), requestConditions, timeout, new Context(key1, value1))
         .getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        headers - BlobHttpHeaders
        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.

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)
        Changes a blob's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.

        Code Samples

         client.setMetadata(Collections.singletonMap("metadata", "value"));
 System.out.println("Set metadata completed");

        For more information, see the Azure Docs

        Parameters:
        metadata - Metadata to associate with the blob. 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)
        Changes a blob's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.

        Code Samples

         BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 System.out.printf("Set metadata completed with status %d%n",
     client.setMetadataWithResponse(Collections.singletonMap("metadata", "value"), requestConditions, timeout,
         new Context(key1, value1)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        metadata - Metadata to associate with the blob. 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.

      • getTags

        public Map<String,​String> getTags()
        Returns the blob's tags.

        Code Samples

         Map<String, String> tags = client.getTags();
 System.out.printf("Number of tags: %d%n", tags.size());

        For more information, see the Azure Docs

        Returns:
        The blob's tags.

      • getTagsWithResponse

        public com.azure.core.http.rest.Response<Map<String,​String>> getTagsWithResponse​(BlobGetTagsOptions options,
                                                                                       Duration timeout,
                                                                                       com.azure.core.util.Context context)
        Returns the blob's tags.

        Code Samples

         Map<String, String> tags = client.getTagsWithResponse(new BlobGetTagsOptions(), timeout,
     new Context(key1, value1)).getValue();
 System.out.printf("Number of tags: %d%n", tags.size());

        For more information, see the Azure Docs

        Parameters:
        options - BlobGetTagsOptions
        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 blob's tags.

      • setTags

        public void setTags​(Map<String,​String> tags)
        Sets user defined tags. The specified tags in this method will replace existing tags. If old values must be preserved, they must be downloaded and included in the call to this method.

        Code Samples

         client.setTags(Collections.singletonMap("tag", "value"));
 System.out.println("Set tag completed");

        For more information, see the Azure Docs

        Parameters:
        tags - Tags to associate with the blob.

      • setTagsWithResponse

        public com.azure.core.http.rest.Response<Void> setTagsWithResponse​(BlobSetTagsOptions options,
                                                                   Duration timeout,
                                                                   com.azure.core.util.Context context)
        Sets user defined tags. The specified tags in this method will replace existing tags. If old values must be preserved, they must be downloaded and included in the call to this method.

        Code Samples

         System.out.printf("Set metadata completed with status %d%n",
     client.setTagsWithResponse(new BlobSetTagsOptions(Collections.singletonMap("tag", "value")), timeout,
         new Context(key1, value1))
         .getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        options - BlobSetTagsOptions
        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.

      • createSnapshot

        public BlobClientBase createSnapshot()
        Creates a read-only snapshot of the blob.

        Code Samples

         System.out.printf("Identifier for the snapshot is %s%n", client.createSnapshot().getSnapshotId());

        For more information, see the Azure Docs

        Returns:
        A response containing a BlobClientBase which is used to interact with the created snapshot, use getSnapshotId() to get the identifier for the snapshot.

      • createSnapshotWithResponse

        public com.azure.core.http.rest.Response<BlobClientBase> createSnapshotWithResponse​(Map<String,​String> metadata,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)
        Creates a read-only snapshot of the blob.

        Code Samples

         Map<String, String> snapshotMetadata = Collections.singletonMap("metadata", "value");
 BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

 System.out.printf("Identifier for the snapshot is %s%n",
     client.createSnapshotWithResponse(snapshotMetadata, requestConditions, timeout,
         new Context(key1, value1)).getValue());

        For more information, see the Azure Docs

        Parameters:
        metadata - Metadata to associate with the resource. 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 a BlobClientBase which is used to interact with the created snapshot, use getSnapshotId() to get the identifier for the snapshot.

      • setAccessTier

        public void setAccessTier​(AccessTier tier)
        Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

        Code Samples

         client.setAccessTier(AccessTier.HOT);
 System.out.println("Set tier completed.");

        For more information, see the Azure Docs

        Parameters:
        tier - The new tier for the blob.

      • setAccessTierWithResponse

        public com.azure.core.http.rest.Response<Void> setAccessTierWithResponse​(AccessTier tier,
                                                                         RehydratePriority priority,
                                                                         String leaseId,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)
        Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

        Code Samples

         System.out.printf("Set tier completed with status code %d%n",
     client.setAccessTierWithResponse(AccessTier.HOT, RehydratePriority.STANDARD, leaseId, timeout,
         new Context(key2, value2)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        tier - The new tier for the blob.
        priority - Optional priority to set for re-hydrating blobs.
        leaseId - The lease ID the active lease on the blob 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:
        A response containing status code and HTTP headers.

      • setAccessTierWithResponse

        public com.azure.core.http.rest.Response<Void> setAccessTierWithResponse​(BlobSetAccessTierOptions options,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)
        Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

        Code Samples

         System.out.printf("Set tier completed with status code %d%n",
     client.setAccessTierWithResponse(new BlobSetAccessTierOptions(AccessTier.HOT)
         .setPriority(RehydratePriority.STANDARD)
         .setLeaseId(leaseId)
         .setTagsConditions(tags),
         timeout, new Context(key2, value2)).getStatusCode());

        For more information, see the Azure Docs

        Parameters:
        options - BlobSetAccessTierOptions
        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.

      • undelete

        public void undelete()
        Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.

        Code Samples

         client.undelete();
 System.out.println("Undelete completed");

        For more information, see the Azure Docs

      • undeleteWithResponse

        public com.azure.core.http.rest.Response<Void> undeleteWithResponse​(Duration timeout,
                                                                    com.azure.core.util.Context context)
        Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.

        Code Samples

         System.out.printf("Undelete completed with status %d%n", client.undeleteWithResponse(timeout,
     new Context(key1, value1)).getStatusCode());

        For more information, see the Azure Docs

        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:
        A response containing status code and HTTP headers.

      • getAccountInfo

        public StorageAccountInfo getAccountInfo()
        Returns the sku name and account kind for the account.

        Code Samples

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

        For more information, see the Azure Docs

        Returns:
        The sku name and account kind.

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

        Code Samples

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

        For more information, see the Azure Docs

        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 sku name and account kind.

      • generateUserDelegationSas

        public String generateUserDelegationSas​(BlobServiceSasSignatureValues blobServiceSasSignatureValues,
                                        UserDelegationKey userDelegationKey,
                                        String accountName,
                                        com.azure.core.util.Context context)
        Generates a user delegation SAS for the blob 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);
 BlobSasPermission myPermission = new BlobSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 client.generateUserDelegationSas(values, userDelegationKey, accountName, new Context(key1, value1));
        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 blob 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);
 BlobSasPermission permission = new BlobSasPermission().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 blob 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);
 BlobSasPermission permission = new BlobSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 // Client must be authenticated via StorageSharedKeyCredential
 client.generateSas(values, new Context(key1, value1));
        Parameters:
        blobServiceSasSignatureValues - BlobServiceSasSignatureValues
        context - Additional context that is passed through the code when generating a SAS.
        Returns:
        A String representing the SAS query parameters.

      • openQueryInputStream

        public InputStream openQueryInputStream​(String expression)
        Opens a blob input stream to query the blob.

        For more information, see the Azure Docs

        Code Samples

         String expression = "SELECT * from BlobStorage";
 InputStream inputStream = client.openQueryInputStream(expression);
 // Now you can read from the input stream like you would normally.
        Parameters:
        expression - The query expression.
        Returns:
        An InputStream object that represents the stream to use for reading the query response.

      • openQueryInputStreamWithResponse

        public com.azure.core.http.rest.Response<InputStream> openQueryInputStreamWithResponse​(BlobQueryOptions queryOptions)
        Opens a blob input stream to query the blob.

        For more information, see the Azure Docs

        Code Samples

         String expression = "SELECT * from BlobStorage";
 BlobQuerySerialization input = new BlobQueryDelimitedSerialization()
     .setColumnSeparator(',')
     .setEscapeChar('\n')
     .setRecordSeparator('\n')
     .setHeadersPresent(true)
     .setFieldQuote('"');
 BlobQuerySerialization output = new BlobQueryJsonSerialization()
     .setRecordSeparator('\n');
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId("leaseId");
 Consumer<BlobQueryError> errorConsumer = System.out::println;
 Consumer<BlobQueryProgress> progressConsumer = progress -> System.out.println("total blob bytes read: "
     + progress.getBytesScanned());
 BlobQueryOptions queryOptions = new BlobQueryOptions(expression)
     .setInputSerialization(input)
     .setOutputSerialization(output)
     .setRequestConditions(requestConditions)
     .setErrorConsumer(errorConsumer)
     .setProgressConsumer(progressConsumer);

 InputStream inputStream = client.openQueryInputStreamWithResponse(queryOptions).getValue();
 // Now you can read from the input stream like you would normally.
        Parameters:
        queryOptions - The query options.
        Returns:
        A response containing status code and HTTP headers including an InputStream object that represents the stream to use for reading the query response.

      • query

        public void query​(OutputStream stream,
                  String expression)
        Queries an entire blob into an output stream.

        For more information, see the Azure Docs

        Code Samples

         ByteArrayOutputStream queryData = new ByteArrayOutputStream();
 String expression = "SELECT * from BlobStorage";
 client.query(queryData, expression);
 System.out.println("Query completed.");
        Parameters:
        stream - A non-null OutputStream instance where the downloaded data will be written.
        expression - The query expression.
        Throws:
        UncheckedIOException - If an I/O error occurs.
        NullPointerException - if stream is null.

      • queryWithResponse

        public BlobQueryResponse queryWithResponse​(BlobQueryOptions queryOptions,
                                           Duration timeout,
                                           com.azure.core.util.Context context)
        Queries an entire blob into an output stream.

        For more information, see the Azure Docs

        Code Samples

         ByteArrayOutputStream queryData = new ByteArrayOutputStream();
 String expression = "SELECT * from BlobStorage";
 BlobQueryJsonSerialization input = new BlobQueryJsonSerialization()
     .setRecordSeparator('\n');
 BlobQueryDelimitedSerialization output = new BlobQueryDelimitedSerialization()
     .setEscapeChar('\0')
     .setColumnSeparator(',')
     .setRecordSeparator('\n')
     .setFieldQuote('\'')
     .setHeadersPresent(true);
 BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);
 Consumer<BlobQueryError> errorConsumer = System.out::println;
 Consumer<BlobQueryProgress> progressConsumer = progress -> System.out.println("total blob bytes read: "
     + progress.getBytesScanned());
 BlobQueryOptions queryOptions = new BlobQueryOptions(expression, queryData)
     .setInputSerialization(input)
     .setOutputSerialization(output)
     .setRequestConditions(requestConditions)
     .setErrorConsumer(errorConsumer)
     .setProgressConsumer(progressConsumer);
 System.out.printf("Query completed with status %d%n",
     client.queryWithResponse(queryOptions, timeout, new Context(key1, value1))
         .getStatusCode());
        Parameters:
        queryOptions - The query options.
        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.
        Throws:
        UncheckedIOException - If an I/O error occurs.
        NullPointerException - if stream is null.

      • setImmutabilityPolicy

        public BlobImmutabilityPolicy setImmutabilityPolicy​(BlobImmutabilityPolicy immutabilityPolicy)
        Sets the immutability policy on a blob, blob snapshot or blob version.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         BlobImmutabilityPolicy policy = new BlobImmutabilityPolicy()
     .setPolicyMode(BlobImmutabilityPolicyMode.LOCKED)
     .setExpiryTime(OffsetDateTime.now().plusDays(1));
 BlobImmutabilityPolicy setPolicy = client.setImmutabilityPolicy(policy);
 System.out.println("Successfully completed setting the immutability policy");
        Parameters:
        immutabilityPolicy - The immutability policy.
        Returns:
        The immutability policy.

      • setImmutabilityPolicyWithResponse

        public com.azure.core.http.rest.Response<BlobImmutabilityPolicy> setImmutabilityPolicyWithResponse​(BlobImmutabilityPolicy immutabilityPolicy,
                                                                                                   BlobRequestConditions requestConditions,
                                                                                                   Duration timeout,
                                                                                                   com.azure.core.util.Context context)
        Sets the immutability policy on a blob, blob snapshot or blob version.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         BlobImmutabilityPolicy immutabilityPolicy = new BlobImmutabilityPolicy()
     .setPolicyMode(BlobImmutabilityPolicyMode.LOCKED)
     .setExpiryTime(OffsetDateTime.now().plusDays(1));
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(1));
 Response<BlobImmutabilityPolicy> response = client.setImmutabilityPolicyWithResponse(immutabilityPolicy,
     requestConditions, timeout, new Context(key1, value1));
 System.out.println("Successfully completed setting the immutability policy");
        Parameters:
        immutabilityPolicy - The immutability policy.
        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 the immutability policy.

      • deleteImmutabilityPolicy

        public void deleteImmutabilityPolicy()
        Delete the immutability policy on a blob, blob snapshot or blob version.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         client.deleteImmutabilityPolicy();
 System.out.println("Completed immutability policy deletion.");

      • deleteImmutabilityPolicyWithResponse

        public com.azure.core.http.rest.Response<Void> deleteImmutabilityPolicyWithResponse​(Duration timeout,
                                                                                    com.azure.core.util.Context context)
        Delete the immutability policy on a blob, blob snapshot or blob version.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         System.out.println("Delete immutability policy completed with status: "
     + client.deleteImmutabilityPolicyWithResponse(timeout, new Context(key1, value1)).getStatusCode());
        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:
        A response containing the immutability policy.

      • setLegalHold

        public BlobLegalHoldResult setLegalHold​(boolean legalHold)
        Sets a legal hold on the blob.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         System.out.println("Legal hold status: " + client.setLegalHold(true));
        Parameters:
        legalHold - Whether or not you want a legal hold on the blob.
        Returns:
        The legal hold result.

      • setLegalHoldWithResponse

        public com.azure.core.http.rest.Response<BlobLegalHoldResult> setLegalHoldWithResponse​(boolean legalHold,
                                                                                       Duration timeout,
                                                                                       com.azure.core.util.Context context)
        Sets a legal hold on the blob.

        NOTE: Blob Versioning must be enabled on your storage account and the blob must be in a container with immutable storage with versioning enabled to call this API.

        Code Samples

         System.out.println("Legal hold status: " + client.setLegalHoldWithResponse(true, timeout,
     new Context(key1, value1)));
        Parameters:
        legalHold - Whether or not you want a legal hold on the blob.
        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 the legal hold result.