[Storage] set_legal_hold for BlobClient (#3335)

Author: vincenttran-msft

sdk/core/azure_core_test_macros/src/lib.rs

@@ -9,9 +9,15 @@ use proc_macro::TokenStream;
 
 /// Attribute client library tests to play back recordings, record sessions, or execute tests without recording.
 ///
+/// # Arguments
+///
+/// * `live` - Run the test only in live mode. The test will be ignored unless `AZURE_TEST_MODE=live`.
+/// * `playback` - Run the test only in playback mode. The test will be ignored unless `AZURE_TEST_MODE=playback`.
+///   Note: Only use this for tests that validate playback-specific behavior. Most tests should not use this option.
+///
 /// # Examples
 ///
-/// For live or recorded tests, you must declare an async function that accepts a `TestContext` and returns a `Result<T, E>`.
+/// For live or recorded tests (the default), you must declare an async function that accepts a `TestContext` and returns a `Result<T, E>`.
 ///
 /// ```
 /// use azure_core::Result;

sdk/core/azure_core_test_macros/src/test.rs

@@ -10,7 +10,7 @@ use syn::{
 };
 
 const INVALID_RECORDED_ATTRIBUTE_MESSAGE: &str =
-    "expected `#[recorded::test]` or `#[recorded::test(live)]`";
+    "expected `#[recorded::test]`, `#[recorded::test(live)]`, or `#[recorded::test(playback)]`";
 const INVALID_RECORDED_FUNCTION_MESSAGE: &str =
     "expected `async fn(TestContext)` function signature with `Result<T, E>` return";
 
@@ -50,6 +50,13 @@ pub fn parse_test(attr: TokenStream, item: TokenStream) -> Result<TokenStream> {
         });
     }
 
+    // Ignore playback-only tests if not running playback tests.
+    if recorded_attrs.playback && test_mode != TestMode::Playback {
+        test_attr.extend(quote! {
+            #[ignore = "skipping playback-only tests"]
+        });
+    }
+
     let fn_name = &original_sig.ident;
     let mut inputs = original_sig.inputs.iter();
     let setup = match inputs.next() {
@@ -110,6 +117,7 @@ static TEST_MODE: LazyLock<TestMode> = LazyLock::new(|| {
 #[derive(Debug, Default)]
 struct Attributes {
     live: bool,
+    playback: bool,
 }
 
 impl Parse for Attributes {
@@ -123,6 +131,7 @@ impl Parse for Attributes {
                     })?;
                     match ident.to_string().as_str() {
                         "live" => attrs.live = true,
+                        "playback" => attrs.playback = true,
                         _ => {
                             return Err(syn::Error::new(
                                 arg.span(),
@@ -139,7 +148,6 @@ impl Parse for Attributes {
                 }
             }
         }
-
         Ok(attrs)
     }
 }
@@ -274,4 +282,33 @@ mod tests {
         };
         parse_test(attr, item).unwrap();
     }
+
+    #[test]
+    fn attributes_parse_playback() {
+        let attr: Attribute = syn::parse_quote! {
+            #[recorded(playback)]
+        };
+        let attrs: Attributes = attr.parse_args().unwrap();
+        assert!(attrs.playback);
+        assert!(!attrs.live);
+    }
+
+    #[test]
+    fn attributes_parse_conflicting() {
+        let attr: Attribute = syn::parse_quote! {
+            #[recorded(live, playback)]
+        };
+        attr.parse_args::<Attributes>().unwrap_err();
+    }
+
+    #[test]
+    fn parse_recorded_playback_only() {
+        let attr = quote! { playback };
+        let item = quote! {
+            async fn playback_only(ctx: TestContext) -> azure_core::Result<()> {
+                todo!()
+            }
+        };
+        parse_test(attr, item).unwrap();
+    }
 }

sdk/storage/azure_storage_blob/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features Added
 
+- Added support for `set_legal_hold` to `BlobClient`.
 - Added `continuation_token` to `PagerOptions` for methods that return a `Pager`.
 
 ### Breaking Changes
@@ -39,10 +40,6 @@
 - The `credential` parameter is now `Optional` on `new()` client constructors, allowing for construction of public access clients.
 - Renamed `Response<T, F>::into_body(self) -> Result<Response<T>>` to `into_model(self) -> Result<Response<T>>`. `into_body(self)` now returns a `ResponseBody`.
 
-### Bugs Fixed
-
-### Other Changes
-
 ## 0.6.0 (2025-10-06)
 
 ### Features Added

sdk/storage/azure_storage_blob/assets.json

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

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

@@ -15,9 +15,9 @@ use crate::{
         AccessTier, BlobClientAcquireLeaseOptions, BlobClientBreakLeaseOptions,
         BlobClientChangeLeaseOptions, BlobClientDeleteOptions, BlobClientDownloadOptions,
         BlobClientGetAccountInfoOptions, BlobClientGetPropertiesOptions, BlobClientGetTagsOptions,
-        BlobClientReleaseLeaseOptions, BlobClientRenewLeaseOptions, BlobClientSetMetadataOptions,
-        BlobClientSetPropertiesOptions, BlobClientSetTagsOptions, BlobClientSetTierOptions,
-        BlobTags, BlockBlobClientUploadOptions, StorageErrorCode,
+        BlobClientReleaseLeaseOptions, BlobClientRenewLeaseOptions, BlobClientSetLegalHoldOptions,
+        BlobClientSetMetadataOptions, BlobClientSetPropertiesOptions, BlobClientSetTagsOptions,
+        BlobClientSetTierOptions, BlobTags, BlockBlobClientUploadOptions, StorageErrorCode,
     },
     pipeline::StorageHeadersPolicy,
     AppendBlobClient, BlobClientOptions, BlockBlobClient, PageBlobClient,
@@ -436,4 +436,18 @@ impl BlobClient {
             Err(e) => Err(e),
         }
     }
+
+    /// Sets a legal hold on the blob.
+    ///
+    /// # Arguments
+    ///
+    /// * `legal_hold` - Specifies the legal hold status to set on the blob.
+    /// * `options` - Optional configuration for the request.
+    pub async fn set_legal_hold(
+        &self,
+        legal_hold: bool,
+        options: Option<BlobClientSetLegalHoldOptions<'_>>,
+    ) -> Result<Response<(), NoFormat>> {
+        self.client.set_legal_hold(legal_hold, options).await
+    }
 }