[Storage] Support find blob by tag in a container. (#19831)

Author: blueww

src/Storage/Storage.Management/ChangeLog.md

@@ -19,8 +19,10 @@
 -->
 ## Upcoming Release
 * Supported create/upgrade storage account with Keyvault from another tenant and access Keyvault with FederatedClientId
-    -  `New-AzStorageAccount`
-    -  `Set-AzStorageAccount`
+  * `New-AzStorageAccount`
+  * `Set-AzStorageAccount`
+* Supported find blobs in a container with a blob tag filter sql expression
+  * `Get-AzStorageBlobByTag`
 
 ## Version 4.10.0
 * Migrated following Azure File dataplane cmdlets from 'Microsoft.Azure.Storage.File 11.2.2' to 'Azure.Storage.Files.Shares 12.10.0'

src/Storage/Storage.Management/help/Get-AzStorageBlobByTag.md

@@ -14,8 +14,8 @@ Lists blobs in a storage account across containers, with a blob tag filter sql e
 
 ```
 Get-AzStorageBlobByTag -TagFilterSqlExpression <String> [-MaxCount <Int32>]
- [-ContinuationToken <BlobContinuationToken>] [-GetBlobProperty] [-Context <IStorageContext>]
- [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
+ [-ContinuationToken <BlobContinuationToken>] [-GetBlobProperty] [-Container <String>]
+ [-Context <IStorageContext>] [-ServerTimeoutPerRequest <Int32>] [-ClientTimeoutPerRequest <Int32>]
  [-DefaultProfile <IAzureContextContainer>] [-ConcurrentTaskCount <Int32>] [<CommonParameters>]
 ```
 
@@ -26,6 +26,8 @@ The **Get-AzStorageBlobByTag** cmdlet lists blobs in a storage account across co
 
 ### Example 1: List all blobs match a specific blob tag, across containers.
 <!-- Skip: Output cannot be splitted from code -->
+
+
 ```
 PS C:\> Get-AzStorageBlobByTag -TagFilterSqlExpression """tag1""='value1'" -Context $ctx 
 
@@ -44,12 +46,14 @@ testblob3
 testblob4                                                                                                                                   False
 ```
 
-This command lists all blobs in a storage accoun, which contains a tag with name "tag1" and value "value1".
+This command lists all blobs in a storage account, which contains a tag with name "tag1" and value "value1".
 
 ### Example 2: List blobs in a specific container and match a specific blob tag
 <!-- Skip: Output cannot be splitted from code -->
+
+
 ```
-PS C:\> Get-AzStorageBlobByTag -TagFilterSqlExpression "@container='containername' AND ""tag1""='value1'" -Context $ctx
+PS C:\> Get-AzStorageBlobByTag -Container 'containername' -TagFilterSqlExpression """tag1""='value1'" -Context $ctx
 
    AccountName: storageaccountname, ContainerName: containername
 
@@ -63,6 +67,8 @@ This command lists blobs in a container and match a specific blob tag.
 
 ### Example 3: List all blobs match a specific blob tag, across containers, and get the blob properties.
 <!-- Skip: Output cannot be splitted from code -->
+
+
 ```
 PS C:\> Get-AzStorageBlobByTag -TagFilterSqlExpression """tag1""='value1'" -GetBlobProperty
 
@@ -81,7 +87,7 @@ testblob3            BlockBlob 100             application/octet-stream       20
 testblob4            BlockBlob 2024            application/octet-stream       2020-07-01 09:42:11Z Hot                                     False      2020-07-01T09:42:11.4283807Z *
 ```
 
-This command lists all blobs in a storage accoun, which contains a tag with name "tag1" and value "value1"， and get the blob properties.
+This command lists all blobs in a storage account, which contains a tag with name "tag1" and value "value1"， and get the blob properties.
 Please note, to get blob properties with parameter -GetBlobProperty, each blob will need an addtional request, so the cmdlet runs show when there are many blobs.
 
 ## PARAMETERS
@@ -117,6 +123,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Container
+Container name, specify this parameter to only return all blobs whose tags match a search expression in the container.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Context
 Azure Storage Context Object
 

src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlobByTag.cs

@@ -63,6 +63,10 @@ public int? MaxCount
         [Parameter(Mandatory = false, HelpMessage = "As the blobs get by tag don't contain blob proeprties, specify tis parameter to get blob properties with an additional request on each blob.")]
         public SwitchParameter GetBlobProperty { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage = "Container name, specify this parameter to only return all blobs whose tags match a search expression in the container.")]
+        [ValidateNotNullOrEmpty]
+        public string Container { get; set; }
+
         // Overwrite the useless parameter
         public override string TagCondition { get; set; }
         protected override bool UseTrack2Sdk()
@@ -94,6 +98,12 @@ internal void ListBlobsByTag(IStorageBlobManagement localChannel, string tagFilt
         {
 
             BlobServiceClient blobServiceClient = Util.GetTrack2BlobServiceClient(localChannel.StorageContext, ClientOptions);
+            BlobContainerClient containerClient = null;
+            if (!string.IsNullOrEmpty(this.Container))
+            {
+                containerClient = blobServiceClient.GetBlobContainerClient(this.Container);
+            }
+
 
             int listCount = InternalMaxCount;
             int MaxListCount = 5000;
@@ -106,9 +116,20 @@ internal void ListBlobsByTag(IStorageBlobManagement localChannel, string tagFilt
             {
                 requestCount = Math.Min(listCount, MaxListCount);
                 realListCount = 0;
-                IEnumerator<Page<TaggedBlobItem>> enumerator = blobServiceClient.FindBlobsByTags(tagFilterSqlExpression, CmdletCancellationToken)
-                    .AsPages(track2ContinuationToken, requestCount)
-                    .GetEnumerator();
+                IEnumerator<Page<TaggedBlobItem>> enumerator;
+
+                if (string.IsNullOrEmpty(this.Container))
+                {
+                    enumerator = blobServiceClient.FindBlobsByTags(tagFilterSqlExpression, CmdletCancellationToken)
+                        .AsPages(track2ContinuationToken, requestCount)
+                        .GetEnumerator();
+                }
+                else
+                {
+                    enumerator = containerClient.FindBlobsByTags(tagFilterSqlExpression, CmdletCancellationToken)
+                        .AsPages(track2ContinuationToken, requestCount)
+                        .GetEnumerator();
+                }
 
                 Page<TaggedBlobItem> page;
                 enumerator.MoveNext();