Return all valid results when filter subscriptions by name. (#19335)

* Return all valid results when filter subscriptions by name.

* Satisfy assert.False() check.

* Modify to support SetCurrentContext function.

* Revert "Modify to support SetCurrentContext function."

This reverts commit d804c94.

* Revert "Revert "Modify to support SetCurrentContext function.""

This reverts commit 2984037.

* Revert all changes of modification.

* Add new function GetSubscriptionListByName.

* Edit Changelog.

* Update Changelog.md.

Co-authored-by: Nori Zhang <“[email protected]”>

Author: NoriZC

src/Accounts/Accounts.Test/AzureRMProfileTests.cs

@@ -424,6 +424,36 @@ public void MultipleTenantsAndSubscriptionsSucceed()
             Assert.Equal(DefaultSubscription.ToString(), subValue.Id.ToString());
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void MultipleTenantsSubscriptionListSucceed()
+        {
+            var tenants = new List<string> { Guid.NewGuid().ToString(), DefaultTenant.ToString() };
+            var secondsubscriptionInTheFirstTenant = Guid.NewGuid().ToString();
+            var firstList = new List<string> { DefaultSubscription.ToString(), secondsubscriptionInTheFirstTenant };
+            var secondList = new List<string> { Guid.NewGuid().ToString() };
+            var thirdList = new List<string> { DefaultSubscription.ToString(), secondsubscriptionInTheFirstTenant };
+            var fourthList = new List<string> { DefaultSubscription.ToString(), secondsubscriptionInTheFirstTenant };
+            var client = SetupTestEnvironment(tenants, firstList, secondList,
+                                                       thirdList, fourthList,
+                                                       thirdList, fourthList,
+                                                       thirdList, fourthList);
+            var subResults = new List<IAzureSubscription>(client.ListSubscriptions());
+            Assert.Equal(7, subResults.Count);
+            var tenantResults = client.ListTenants();
+            Assert.Equal(2, tenantResults.Count());
+            tenantResults = client.ListTenants(DefaultTenant.ToString());
+            Assert.Single(tenantResults);
+            IAzureSubscription subValue;
+            IEnumerable<IAzureSubscription> subValueList;
+            Assert.True(client.TryGetSubscriptionById(DefaultTenant.ToString(), DefaultSubscription.ToString(), out subValue));
+            Assert.Equal(DefaultSubscription.ToString(), subValue.Id.ToString());
+            Assert.True(client.TryGetSubscriptionListByName(DefaultTenant.ToString(),
+                MockSubscriptionClientFactory.GetSubscriptionNameFromId(DefaultSubscription.ToString()),
+                out subValueList));
+            Assert.Equal(DefaultSubscription.ToString(), subValue.Id.ToString());
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void SingleTenantAndSubscriptionSucceeds()
@@ -449,6 +479,44 @@ public void SingleTenantAndSubscriptionSucceeds()
             Assert.Equal(DefaultSubscription.ToString(), subValue.Id.ToString());
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void SingleTenantSubscriptionListSucceed()
+        {
+            var tenants = new List<string> { DefaultTenant.ToString() };
+            var secondsubscriptionInTheFirstTenant = Guid.NewGuid().ToString();
+            var firstList = new List<string> { DefaultSubscription.ToString()};
+            var secondList = firstList;
+            var thirdList = firstList;
+            var fourthList = firstList;
+            var client = SetupTestEnvironment(tenants, firstList, secondList, thirdList, fourthList);
+            var tenantResults = client.ListTenants();
+            Assert.Single(tenantResults);
+            IEnumerable<IAzureSubscription> subValueList;
+            Assert.True(client.TryGetSubscriptionListByName(DefaultTenant.ToString(),
+                MockSubscriptionClientFactory.GetSubscriptionNameFromId(DefaultSubscription.ToString()),
+                out subValueList));
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void GetSubscriptionListByNameCorrect()
+        {
+            var tenants = new List<string> { DefaultTenant.ToString() };
+            var firstList = new List<string> { DefaultSubscription.ToString() };
+            var secondList = firstList;
+            var thirdList = firstList;
+            var fourthList = firstList;
+            var client = SetupTestEnvironment(tenants, firstList, secondList, thirdList, fourthList);
+            var tenantResults = client.ListTenants();
+            Assert.Single(tenantResults);
+            IEnumerable<IAzureSubscription> subValueList;
+            client.TryGetSubscriptionListByName(DefaultTenant.ToString(),
+                MockSubscriptionClientFactory.GetSubscriptionNameFromId(DefaultSubscription.ToString()),
+                out subValueList);
+            Assert.Equal(2, subValueList.Count());
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void SubscriptionNotFoundDoesNotThrow()
@@ -470,6 +538,23 @@ public void SubscriptionNotFoundDoesNotThrow()
             Assert.False(client.TryGetSubscriptionByName("random-tenant", "random-subscription", out subValue));
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void SubscriptionListNotFoundDoesNotThrow()
+        {
+            var tenants = new List<string> { DefaultTenant.ToString() };
+            string randomSubscriptionId = Guid.NewGuid().ToString();
+            var firstList = new List<string> { randomSubscriptionId };
+            var secondList = firstList;
+            var thirdList = firstList;
+            var fourthList = firstList;
+            var client = SetupTestEnvironment(tenants, firstList, secondList,
+                                                       thirdList, fourthList,
+                                                       thirdList, fourthList);
+            IEnumerable<IAzureSubscription> subValueList;
+            Assert.False(client.TryGetSubscriptionListByName("random-tenant", "random-subscription", out subValueList));
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void NoTenantsDoesNotThrow()
@@ -496,6 +581,20 @@ public void NoSubscriptionsInListDoesNotThrow()
             Assert.False(client.TryGetSubscriptionByName(DefaultTenant.ToString(), "random-name", out subValue));
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void NoSubscriptionsInListDoesNotThrowForList()
+        {
+            var tenants = new List<string> { DefaultTenant.ToString() };
+            var subscriptions = new List<string>();
+            var client = SetupTestEnvironment(tenants, subscriptions, subscriptions,
+                                                       subscriptions, subscriptions,
+                                                       subscriptions, subscriptions);
+            Assert.Empty(client.ListSubscriptions());
+            IEnumerable<IAzureSubscription> subValueList;
+            Assert.False(client.TryGetSubscriptionListByName(DefaultTenant.ToString(), "random-name", out subValueList));
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void SetContextPreservesTokenCache()

src/Accounts/Accounts/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Supported returning all subscriptions with specified name while using `Get-AzSubscription` with paramater `SubscriptionName`. [#19295]
 
 ## Version 2.9.1
 * Implemented `SupportsShouldProcess` for `Invoke-AzRestMethod`

src/Accounts/Accounts/Models/RMProfileClient.cs

@@ -421,6 +421,13 @@ public bool TryGetSubscriptionByName(string tenantId, string subscriptionName, o
             return subscription != null;
         }
 
+        public bool TryGetSubscriptionListByName(string tenantId, string subscriptionName, out IEnumerable<IAzureSubscription> subscriptionList)
+        {
+            subscriptionList = ListSubscriptions(tenantId);
+            subscriptionList = subscriptionList.Where(s => s.Name.Equals(subscriptionName, StringComparison.OrdinalIgnoreCase));
+            return subscriptionList.Any();
+        }
+
         private IAzureSubscription GetFirstSubscription(string tenantId)
         {
             IEnumerable<IAzureSubscription> subscriptionList = ListSubscriptions(tenantId);

src/Accounts/Accounts/Subscription/GetAzureRMSubscription.cs

@@ -19,6 +19,7 @@
 using Microsoft.Azure.Commands.Profile.Properties;
 using Microsoft.Azure.Commands.ResourceManager.Common;
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Management.Automation;
@@ -66,15 +67,15 @@ public override void ExecuteCmdlet()
         {
             if (!string.IsNullOrWhiteSpace(this.SubscriptionName))
             {
-                IAzureSubscription result;
+                IEnumerable<IAzureSubscription> result;
                 try
                 {
-                    if (!this._client.TryGetSubscriptionByName(TenantId, this.SubscriptionName, out result))
+                    if (!this._client.TryGetSubscriptionListByName(TenantId, this.SubscriptionName, out result))
                     {
                         ThrowSubscriptionNotFoundError(this.TenantId, this.SubscriptionName);
                     }
 
-                    WriteObject(new PSAzureSubscription(result));
+                    WriteObject(result.Select((s) => new PSAzureSubscription(s)), enumerateCollection: true); 
                 }
                 catch (AadAuthenticationException exception)
                 {