[Storage] find_blobs_by_tags for BlobServiceClient and BlobContainerClient (#2973)

Author: vincenttran-msft

.vscode/cspell.json

@@ -50,6 +50,7 @@
     "etag",
     "eventhub",
     "eventhubs",
+    "headerless",
     "hmac",
     "iothub",
     "keyvault",

sdk/storage/.dict.txt

@@ -5,22 +5,25 @@ blockid
 blocklist
 blocklisttype
 copyid
+deletedwithversions
 deletetype
+firsttag
+immutabilitypolicy
 incrementalcopy
 legalhold
 missingcontainer
-RAGRS
-restype
-testcontainer
 pagelist
-prevsnapshot
-deletedwithversions
-immutabilitypolicy
-uncommittedblobs
 policyid
+prevsnapshot
+RAGRS
+restype
 ruleid
-westus
+secondtag
 testblob1
 testblob2
 testblob3
 testblob4
+testcontainer
+uncommittedblobs
+westus
+yourtagname

sdk/storage/azure_storage_blob/assets.json

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

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

@@ -12,10 +12,11 @@ use crate::{
     models::{
         BlobContainerClientAcquireLeaseOptions, BlobContainerClientBreakLeaseOptions,
         BlobContainerClientChangeLeaseOptions, BlobContainerClientCreateOptions,
-        BlobContainerClientDeleteOptions, BlobContainerClientGetAccountInfoOptions,
-        BlobContainerClientGetPropertiesOptions, BlobContainerClientListBlobFlatSegmentOptions,
-        BlobContainerClientReleaseLeaseOptions, BlobContainerClientRenewLeaseOptions,
-        BlobContainerClientSetMetadataOptions, ListBlobsFlatSegmentResponse,
+        BlobContainerClientDeleteOptions, BlobContainerClientFindBlobsByTagsOptions,
+        BlobContainerClientGetAccountInfoOptions, BlobContainerClientGetPropertiesOptions,
+        BlobContainerClientListBlobFlatSegmentOptions, BlobContainerClientReleaseLeaseOptions,
+        BlobContainerClientRenewLeaseOptions, BlobContainerClientSetMetadataOptions,
+        FilterBlobSegment, ListBlobsFlatSegmentResponse,
     },
     pipeline::StorageHeadersPolicy,
     BlobClient, BlobContainerClientOptions,
@@ -159,6 +160,31 @@ impl BlobContainerClient {
         self.client.list_blob_flat_segment(options)
     }
 
+    /// Returns a list of blobs in the container whose tags match a given search expression.
+    ///
+    /// # Arguments
+    ///
+    /// * `filter_expression` - The expression to find blobs whose tags matches the specified condition.
+    ///   eg.
+    /// ```text
+    /// "\"yourtagname\"='firsttag' and \"yourtagname2\"='secondtag'"
+    /// ```
+    ///   To specify a container, eg.
+    /// ```text
+    /// "@container='containerName' and \"Name\"='C'"
+    /// ```
+    /// See [`format_filter_expression()`](crate::format_filter_expression) for help with the expected String format.
+    /// * `options` - Optional parameters for the request.
+    pub async fn find_blobs_by_tags(
+        &self,
+        filter_expression: &str,
+        options: Option<BlobContainerClientFindBlobsByTagsOptions<'_>>,
+    ) -> Result<Response<FilterBlobSegment, XmlFormat>> {
+        self.client
+            .find_blobs_by_tags(filter_expression, options)
+            .await
+    }
+
     /// Requests a new lease on a container. The lease lock duration can be 15 to 60 seconds, or can be infinite.
     ///
     /// # Arguments

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

@@ -5,9 +5,10 @@ use crate::{
     generated::clients::BlobServiceClient as GeneratedBlobServiceClient,
     generated::models::BlobServiceClientGetAccountInfoResult,
     models::{
-        BlobServiceClientGetAccountInfoOptions, BlobServiceClientGetPropertiesOptions,
-        BlobServiceClientListContainersSegmentOptions, BlobServiceClientSetPropertiesOptions,
-        BlobServiceProperties, ListContainersSegmentResponse,
+        BlobServiceClientFindBlobsByTagsOptions, BlobServiceClientGetAccountInfoOptions,
+        BlobServiceClientGetPropertiesOptions, BlobServiceClientListContainersSegmentOptions,
+        BlobServiceClientSetPropertiesOptions, BlobServiceProperties, FilterBlobSegment,
+        ListContainersSegmentResponse,
     },
     pipeline::StorageHeadersPolicy,
     BlobContainerClient, BlobServiceClientOptions,
@@ -98,6 +99,31 @@ impl BlobServiceClient {
         self.client.list_containers_segment(options)
     }
 
+    /// Returns a list of blobs across all containers whose tags match a given search expression.
+    ///
+    /// # Arguments
+    ///
+    /// * `filter_expression` - The expression to find blobs whose tags matches the specified condition.
+    ///   eg.
+    /// ```text
+    /// "\"yourtagname\"='firsttag' and \"yourtagname2\"='secondtag'"
+    /// ```
+    ///   To specify a container, eg.
+    /// ```text
+    /// "@container='containerName' and \"Name\"='C'"
+    /// ```
+    /// See [`format_filter_expression()`](crate::format_filter_expression) for help with the expected String format.
+    /// * `options` - Optional parameters for the request.
+    pub async fn find_blobs_by_tags(
+        &self,
+        filter_expression: &str,
+        options: Option<BlobServiceClientFindBlobsByTagsOptions<'_>>,
+    ) -> Result<Response<FilterBlobSegment, XmlFormat>> {
+        self.client
+            .find_blobs_by_tags(filter_expression, options)
+            .await
+    }
+
     /// Sets properties for a Storage account's Blob service endpoint, including properties for Storage Analytics and CORS rules.
     ///
     /// # Arguments

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

@@ -3,7 +3,7 @@
 
 use crate::models::{
     AppendBlobClientCreateOptions, BlobTag, BlobTags, BlockBlobClientUploadBlobFromUrlOptions,
-    PageBlobClientCreateOptions,
+    BlockBlobClientUploadOptions, PageBlobClientCreateOptions,
 };
 use azure_core::error::ErrorKind;
 use std::collections::HashMap;
@@ -47,6 +47,26 @@ impl<'a> BlockBlobClientUploadBlobFromUrlOptions<'a> {
     }
 }
 
+/// Augments the current options bag to include blob tags.
+/// # Arguments
+///
+/// * `self` - The options bag to be modified.
+/// * `tags` - A HashMap of key-value pairs representing the blob tags.
+impl<'a> BlockBlobClientUploadOptions<'a> {
+    pub fn with_tags(self, tags: HashMap<String, String>) -> Self {
+        let tags_string = tags
+            .iter()
+            .map(|(key, value)| format!("{}={}", key, value))
+            .collect::<Vec<_>>()
+            .join("&");
+
+        Self {
+            blob_tags_string: Some(tags_string),
+            ..self
+        }
+    }
+}
+
 /// Converts a `BlobTags` struct into `HashMap<String, String>`.
 impl TryFrom<BlobTags> for HashMap<String, String> {
     type Error = azure_core::Error;