[Storage] Add set_metadata to BlobClient (#2477)

Author: vincenttran-msft

sdk/storage/assets.json

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

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

@@ -11,8 +11,9 @@ use crate::{
     models::{BlockList, BlockListType, BlockLookupList},
     pipeline::StorageHeadersPolicy,
     BlobClientDeleteOptions, BlobClientDownloadOptions, BlobClientGetPropertiesOptions,
-    BlobClientOptions, BlockBlobClientCommitBlockListOptions, BlockBlobClientGetBlockListOptions,
-    BlockBlobClientStageBlockOptions, BlockBlobClientUploadOptions,
+    BlobClientOptions, BlobClientSetMetadataOptions, BlockBlobClientCommitBlockListOptions,
+    BlockBlobClientGetBlockListOptions, BlockBlobClientStageBlockOptions,
+    BlockBlobClientUploadOptions,
 };
 use azure_core::{
     credentials::TokenCredential,
@@ -149,6 +150,21 @@ impl BlobClient {
         Ok(response)
     }
 
+    /// Sets user-defined metadata for the specified blob as one or more name-value pairs. Each call to this operation
+    /// replaces all existing metadata attached to the blob. To remove all metadata from the blob, call this operation with
+    /// no metadata headers.
+    ///
+    /// # Arguments
+    ///
+    /// * `options` - Optional configuration for the request.
+    pub async fn set_metadata(
+        &self,
+        options: Option<BlobClientSetMetadataOptions<'_>>,
+    ) -> Result<Response<()>> {
+        let response = self.client.set_metadata(options).await?;
+        Ok(response)
+    }
+
     /// Deletes the blob.
     ///
     /// # Arguments

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

@@ -17,10 +17,11 @@ pub use crate::generated::clients::{
 };
 pub use crate::generated::models::{
     BlobClientDeleteOptions, BlobClientDownloadOptions, BlobClientGetPropertiesOptions,
-    BlobContainerClientCreateOptions, BlobContainerClientDeleteOptions,
-    BlobContainerClientGetPropertiesOptions, BlobServiceClientGetPropertiesOptions,
-    BlockBlobClientCommitBlockListOptions, BlockBlobClientGetBlockListOptions,
-    BlockBlobClientStageBlockOptions, BlockBlobClientUploadOptions,
+    BlobClientSetMetadataOptions, BlobContainerClientCreateOptions,
+    BlobContainerClientDeleteOptions, BlobContainerClientGetPropertiesOptions,
+    BlobServiceClientGetPropertiesOptions, BlockBlobClientCommitBlockListOptions,
+    BlockBlobClientGetBlockListOptions, BlockBlobClientStageBlockOptions,
+    BlockBlobClientUploadOptions,
 };
 
 pub mod models {

sdk/storage/azure_storage_blob/src/generated/models/header_traits.rs

@@ -11,10 +11,11 @@ use azure_storage_blob::{
         BlobClientDownloadResultHeaders, BlobClientGetPropertiesResultHeaders, BlockListType,
         BlockLookupList, LeaseState,
     },
-    BlobClient, BlobClientOptions, BlobContainerClient, BlobContainerClientOptions,
+    BlobClient, BlobClientOptions, BlobClientSetMetadataOptions, BlobContainerClient,
+    BlobContainerClientOptions, BlockBlobClientUploadOptions,
 };
 use azure_storage_blob_test::recorded_test_setup;
-use std::error::Error;
+use std::{collections::HashMap, error::Error};
 
 #[recorded::test]
 async fn test_get_blob_properties(ctx: TestContext) -> Result<(), Box<dyn Error>> {
@@ -311,6 +312,88 @@ async fn test_download_blob(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     Ok(())
 }
 
+#[recorded::test]
+async fn test_set_blob_metadata(ctx: TestContext) -> Result<(), Box<dyn Error>> {
+    // Recording Setup
+
+    let recording = ctx.recording();
+    let (options, endpoint) = recorded_test_setup(recording);
+    let container_name = recording
+        .random_string::<17>(Some("container"))
+        .to_ascii_lowercase();
+    let blob_name = recording
+        .random_string::<12>(Some("blob"))
+        .to_ascii_lowercase();
+
+    let container_client_options = BlobContainerClientOptions {
+        client_options: options.clone(),
+        ..Default::default()
+    };
+    //Act
+    let container_client = BlobContainerClient::new(
+        &endpoint,
+        container_name.clone(),
+        recording.credential(),
+        Some(container_client_options),
+    )?;
+    container_client.create_container(None).await?;
+
+    let blob_client_options = BlobClientOptions {
+        client_options: options.clone(),
+        ..Default::default()
+    };
+    let blob_client = BlobClient::new(
+        &endpoint,
+        container_name,
+        blob_name,
+        recording.credential(),
+        Some(blob_client_options),
+    )?;
+
+    let data = b"hello rusty world";
+
+    // Upload Blob With Metadata
+    let initial_metadata = HashMap::from([("initial".to_string(), "metadata".to_string())]);
+
+    let options_with_metadata = BlockBlobClientUploadOptions {
+        metadata: Some(initial_metadata.clone()),
+        ..Default::default()
+    };
+    blob_client
+        .upload(
+            RequestContent::from(data.to_vec()),
+            false,
+            u64::try_from(data.len())?,
+            Some(options_with_metadata),
+        )
+        .await?;
+    // Assert
+    let response = blob_client.get_properties(None).await?;
+    let response_metadata = response.metadata()?;
+    assert_eq!(initial_metadata, response_metadata);
+
+    // Set Metadata With Values
+    let update_metadata = HashMap::from([("updated".to_string(), "values".to_string())]);
+    let set_metadata_options = BlobClientSetMetadataOptions {
+        metadata: Some(update_metadata.clone()),
+        ..Default::default()
+    };
+    blob_client.set_metadata(Some(set_metadata_options)).await?;
+    // Assert
+    let response = blob_client.get_properties(None).await?;
+    let response_metadata = response.metadata()?;
+    assert_eq!(update_metadata, response_metadata);
+
+    // Set Metadata No Values (Clear Metadata)
+    blob_client.set_metadata(None).await?;
+    // Assert
+    let response = blob_client.get_properties(None).await?;
+    let response_metadata = response.metadata()?;
+    assert_eq!(HashMap::new(), response_metadata);
+
+    Ok(())
+}
+
 #[recorded::test]
 async fn test_put_block_list(ctx: TestContext) -> Result<(), Box<dyn Error>> {
     // Recording Setup

sdk/storage/azure_storage_blob/src/generated/models/pub_models.rs

@@ -1,4 +1,4 @@
 directory: specification/storage/Microsoft.BlobStorage
-commit: 18f73ced716fd483afc074ac0960a4eb79547e02
+commit: ab781596b134018f770fa686893a6ead3be1b5fa
 repo: Azure/azure-rest-api-specs
 additionalDirectories: