[Storage] Lease operations for BlobClient and BlobContainerClient, feature parity for AppendBlobClient (Azure#2739)

Author: vincenttran-msft

sdk/storage/assets.json

@@ -1,6 +1,6 @@
 {
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "rust",
-  "Tag": "rust/azure_storage_blob_83b2698a78",
+  "Tag": "rust/azure_storage_blob_f12afa9550",
   "TagPrefix": "rust/azure_storage_blob"
 }

sdk/storage/azure_storage_blob/src/clients/append_blob_client.rs

@@ -3,7 +3,12 @@
 
 use crate::{
     generated::clients::AppendBlobClient as GeneratedAppendBlobClient,
-    models::{AppendBlobClientCreateOptions, AppendBlobClientCreateResult},
+    models::{
+        AppendBlobClientAppendBlockFromUrlOptions, AppendBlobClientAppendBlockFromUrlResult,
+        AppendBlobClientAppendBlockOptions, AppendBlobClientAppendBlockResult,
+        AppendBlobClientCreateOptions, AppendBlobClientCreateResult, AppendBlobClientSealOptions,
+        AppendBlobClientSealResult,
+    },
     pipeline::StorageHeadersPolicy,
     AppendBlobClientOptions, BlobClientOptions,
 };
@@ -97,4 +102,53 @@ impl AppendBlobClient {
     ) -> Result<Response<AppendBlobClientCreateResult, NoFormat>> {
         self.client.create(options).await
     }
+
+    /// Commits a new block of data to the end of an Append blob.
+    ///
+    /// # Arguments
+    ///
+    /// * `data` - The blob data to append.
+    /// * `content_length` - Total length of the blob data to be appended.
+    /// * `options` - Optional configuration for the request.
+    pub async fn append_block(
+        &self,
+        data: RequestContent<Bytes>,
+        content_length: u64,
+        options: Option<AppendBlobClientAppendBlockOptions<'_>>,
+    ) -> Result<Response<AppendBlobClientAppendBlockResult, NoFormat>> {
+        self.client
+            .append_block(data, content_length, options)
+            .await
+    }
+
+    /// Creates a new block to be committed as part of an Append blob where the contents are
+    /// read from a URL.
+    ///
+    /// # Arguments
+    ///
+    /// * `source_url` - The URL of the copy source.
+    /// * `content_length` - Total length of the blob data to be appended.
+    /// * `options` - Optional configuration for the request.
+    pub async fn append_block_from_url(
+        &self,
+        source_url: String,
+        content_length: u64,
+        options: Option<AppendBlobClientAppendBlockFromUrlOptions<'_>>,
+    ) -> Result<Response<AppendBlobClientAppendBlockFromUrlResult, NoFormat>> {
+        self.client
+            .append_block_from_url(source_url, content_length, options)
+            .await
+    }
+
+    /// Seals the Append blob to make it read-only. Seal is supported only on version 2019-12-12 or later.
+    ///
+    /// # Arguments
+    ///
+    /// * `options` - Optional parameters for the request.
+    pub async fn seal(
+        &self,
+        options: Option<AppendBlobClientSealOptions<'_>>,
+    ) -> Result<Response<AppendBlobClientSealResult, NoFormat>> {
+        self.client.seal(options).await
+    }
 }

sdk/storage/azure_storage_blob/src/clients/blob_client.rs

@@ -4,14 +4,16 @@
 use crate::{
     generated::clients::BlobClient as GeneratedBlobClient,
     generated::models::{
-        BlobClientDownloadResult, BlobClientGetPropertiesResult,
-        BlockBlobClientCommitBlockListResult, BlockBlobClientStageBlockResult,
-        BlockBlobClientUploadResult,
+        BlobClientAcquireLeaseResult, BlobClientBreakLeaseResult, BlobClientChangeLeaseResult,
+        BlobClientDownloadResult, BlobClientGetPropertiesResult, BlobClientReleaseLeaseResult,
+        BlobClientRenewLeaseResult, BlockBlobClientCommitBlockListResult,
+        BlockBlobClientStageBlockResult, BlockBlobClientUploadResult,
     },
     models::{
-        AccessTierOptional, BlobClientDeleteOptions, BlobClientDownloadOptions,
-        BlobClientGetPropertiesOptions, BlobClientSetMetadataOptions,
-        BlobClientSetPropertiesOptions, BlobClientSetTierOptions,
+        AccessTierOptional, BlobClientAcquireLeaseOptions, BlobClientBreakLeaseOptions,
+        BlobClientChangeLeaseOptions, BlobClientDeleteOptions, BlobClientDownloadOptions,
+        BlobClientGetPropertiesOptions, BlobClientReleaseLeaseOptions, BlobClientRenewLeaseOptions,
+        BlobClientSetMetadataOptions, BlobClientSetPropertiesOptions, BlobClientSetTierOptions,
         BlockBlobClientCommitBlockListOptions, BlockBlobClientUploadOptions, BlockList,
         BlockListType, BlockLookupList,
     },
@@ -233,4 +235,82 @@ impl BlobClient {
     ) -> Result<Response<(), NoFormat>> {
         self.client.set_tier(tier, options).await
     }
+
+    /// Requests a new lease on a blob. The lease lock duration can be 15 to 60 seconds, or can be infinite.
+    ///
+    /// # Arguments
+    ///
+    /// * `duration` - Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A
+    ///   non-infinite lease can be between 15 and 60 seconds.
+    /// * `options` - Optional configuration for the request.
+    pub async fn acquire_lease(
+        &self,
+        duration: i32,
+        options: Option<BlobClientAcquireLeaseOptions<'_>>,
+    ) -> Result<Response<BlobClientAcquireLeaseResult, NoFormat>> {
+        self.client.acquire_lease(duration, options).await
+    }
+
+    /// Ends a lease and ensures that another client can't acquire a new lease until the current lease
+    /// period has expired.
+    ///
+    /// # Arguments
+    ///
+    /// * `options` - Optional configuration for the request.
+    pub async fn break_lease(
+        &self,
+        options: Option<BlobClientBreakLeaseOptions<'_>>,
+    ) -> Result<Response<BlobClientBreakLeaseResult, NoFormat>> {
+        self.client.break_lease(options).await
+    }
+
+    /// Changes the ID of an existing lease to the proposed lease ID.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `proposed_lease_id` - The proposed lease ID for the blob.
+    /// * `options` - Optional configuration for the request.
+    pub async fn change_lease(
+        &self,
+        lease_id: String,
+        proposed_lease_id: String,
+        options: Option<BlobClientChangeLeaseOptions<'_>>,
+    ) -> Result<Response<BlobClientChangeLeaseResult, NoFormat>> {
+        self.client
+            .change_lease(lease_id, proposed_lease_id, options)
+            .await
+    }
+
+    /// Frees the lease so that another client can immediately acquire a lease
+    /// against the blob as soon as the release is complete.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `options` - Optional configuration for the request.
+    pub async fn release_lease(
+        &self,
+        lease_id: String,
+        options: Option<BlobClientReleaseLeaseOptions<'_>>,
+    ) -> Result<Response<BlobClientReleaseLeaseResult, NoFormat>> {
+        self.client.release_lease(lease_id, options).await
+    }
+
+    /// Renews the lease on a blob.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `options` - Optional configuration for the request.
+    pub async fn renew_lease(
+        &self,
+        lease_id: String,
+        options: Option<BlobClientRenewLeaseOptions<'_>>,
+    ) -> Result<Response<BlobClientRenewLeaseResult, NoFormat>> {
+        self.client.renew_lease(lease_id, options).await
+    }
 }

sdk/storage/azure_storage_blob/src/clients/blob_container_client.rs

@@ -3,11 +3,18 @@
 
 use crate::{
     generated::clients::BlobContainerClient as GeneratedBlobContainerClient,
-    generated::models::BlobContainerClientGetPropertiesResult,
+    generated::models::{
+        BlobContainerClientAcquireLeaseResult, BlobContainerClientBreakLeaseResult,
+        BlobContainerClientChangeLeaseResult, BlobContainerClientGetPropertiesResult,
+        BlobContainerClientReleaseLeaseResult, BlobContainerClientRenewLeaseResult,
+    },
     models::{
-        BlobContainerClientCreateOptions, BlobContainerClientDeleteOptions,
-        BlobContainerClientGetPropertiesOptions, BlobContainerClientListBlobFlatSegmentOptions,
-        BlobContainerClientSetMetadataOptions, ListBlobsFlatSegmentResponse,
+        BlobContainerClientAcquireLeaseOptions, BlobContainerClientBreakLeaseOptions,
+        BlobContainerClientChangeLeaseOptions, BlobContainerClientCreateOptions,
+        BlobContainerClientDeleteOptions, BlobContainerClientGetPropertiesOptions,
+        BlobContainerClientListBlobFlatSegmentOptions, BlobContainerClientReleaseLeaseOptions,
+        BlobContainerClientRenewLeaseOptions, BlobContainerClientSetMetadataOptions,
+        ListBlobsFlatSegmentResponse,
     },
     pipeline::StorageHeadersPolicy,
     BlobClient, BlobContainerClientOptions,
@@ -157,4 +164,82 @@ impl BlobContainerClient {
     ) -> Result<PageIterator<Response<ListBlobsFlatSegmentResponse, XmlFormat>>> {
         self.client.list_blob_flat_segment(options)
     }
+
+    /// Requests a new lease on a container. The lease lock duration can be 15 to 60 seconds, or can be infinite.
+    ///
+    /// # Arguments
+    ///
+    /// * `duration` - Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A
+    ///   non-infinite lease can be between 15 and 60 seconds.
+    /// * `options` - Optional configuration for the request.
+    pub async fn acquire_lease(
+        &self,
+        duration: i32,
+        options: Option<BlobContainerClientAcquireLeaseOptions<'_>>,
+    ) -> Result<Response<BlobContainerClientAcquireLeaseResult, NoFormat>> {
+        self.client.acquire_lease(duration, options).await
+    }
+
+    /// Ends a lease and ensures that another client can't acquire a new lease until the current lease
+    /// period has expired.
+    ///
+    /// # Arguments
+    ///
+    /// * `options` - Optional configuration for the request.
+    pub async fn break_lease(
+        &self,
+        options: Option<BlobContainerClientBreakLeaseOptions<'_>>,
+    ) -> Result<Response<BlobContainerClientBreakLeaseResult, NoFormat>> {
+        self.client.break_lease(options).await
+    }
+
+    /// Changes the ID of an existing lease to the proposed lease ID.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `proposed_lease_id` - The proposed lease ID for the container.
+    /// * `options` - Optional configuration for the request.
+    pub async fn change_lease(
+        &self,
+        lease_id: String,
+        proposed_lease_id: String,
+        options: Option<BlobContainerClientChangeLeaseOptions<'_>>,
+    ) -> Result<Response<BlobContainerClientChangeLeaseResult, NoFormat>> {
+        self.client
+            .change_lease(lease_id, proposed_lease_id, options)
+            .await
+    }
+
+    /// Frees the lease so that another client can immediately acquire a lease
+    /// against the container as soon as the release is complete.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `options` - Optional configuration for the request.
+    pub async fn release_lease(
+        &self,
+        lease_id: String,
+        options: Option<BlobContainerClientReleaseLeaseOptions<'_>>,
+    ) -> Result<Response<BlobContainerClientReleaseLeaseResult, NoFormat>> {
+        self.client.release_lease(lease_id, options).await
+    }
+
+    /// Renews the lease on a container.
+    ///
+    /// # Arguments
+    ///
+    /// * `lease_id` - A lease ID for the source path. The source path must have an active lease and the
+    ///   lease ID must match.
+    /// * `options` - Optional configuration for the request.
+    pub async fn renew_lease(
+        &self,
+        lease_id: String,
+        options: Option<BlobContainerClientRenewLeaseOptions<'_>>,
+    ) -> Result<Response<BlobContainerClientRenewLeaseResult, NoFormat>> {
+        self.client.renew_lease(lease_id, options).await
+    }
 }