Az.StorageSync - Migrate AAD to MSGraph (#16996)

* First Draft for making changes of msgraph

* MsGraph : Record tests

* Update TestRegisteredServer.json

Co-authored-by: Yabo Hu <[email protected]>

Author: ankushbindlish2

src/StorageSync/StorageSync.Test/Common/MockStorageSyncResourceManager.cs

@@ -15,6 +15,7 @@
 using Commands.StorageSync.Interop.Clients;
 using Commands.StorageSync.Interop.DataObjects;
 using Commands.StorageSync.Interop.Interfaces;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
 using Microsoft.Azure.Commands.StorageSync.Common;
 using Microsoft.Azure.Commands.StorageSync.Interfaces;
 using Microsoft.Azure.Test.HttpRecorder;
@@ -150,5 +151,11 @@ public string GetTenantId()
             }
             return tenantId;
         }
+
+        /// <summary>
+        /// Get Service Principal Or Null
+        /// </summary>
+        /// <returns>MicrosoftGraphServicePrincipal</returns>
+        public MicrosoftGraphServicePrincipal GetServicePrincipalOrNull() => new MicrosoftGraphServicePrincipal() { Id = "384dab06-7a70-4ecf-a04e-284602199124" }; // Change Object ID if we are using some other tenant
     }
 }

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestCloudEndpoint.json

@@ -14,9 +14,9 @@
 
 using Microsoft.Azure.Commands.Common.Authentication;
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0;
 using Microsoft.Azure.Commands.StorageSync.Common;
 using Microsoft.Azure.Commands.StorageSync.Interfaces;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01;
 using Microsoft.Azure.Management.Internal.Resources;
 using Microsoft.Azure.Management.ResourceManager.Version2021_01_01;
@@ -185,17 +185,17 @@ private void SetupManagementClients(MockContext context)
             var subClient = context.GetServiceClient<SubscriptionClient>(TestEnvironmentFactory.GetTestEnvironment());
             var storageSyncClient = context.GetServiceClient<StorageSyncManagementClient>(TestEnvironmentFactory.GetTestEnvironment());
             var storageClient = context.GetServiceClient<StorageManagementClient>(TestEnvironmentFactory.GetTestEnvironment());
-            GraphRbacManagementClient rbacClient = GetGraphClient(context);
+            MicrosoftGraphClient microsoftGraphClient = GetGraphClient(context);
             var authClient = context.GetServiceClient<AuthorizationManagementClient>(TestEnvironmentFactory.GetTestEnvironment());
-            _helper.SetupManagementClients(rmClient, subClient, storageSyncClient, storageClient, rbacClient, authClient);
+            _helper.SetupManagementClients(rmClient, subClient, storageSyncClient, storageClient, microsoftGraphClient, authClient);
         }
 
         /// <summary>
         /// Gets the graph client.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <returns>GraphRbacManagementClient.</returns>
-        private GraphRbacManagementClient GetGraphClient(MockContext context)
+        /// <returns>MicrosoftGraphClient.</returns>
+        private MicrosoftGraphClient GetGraphClient(MockContext context)
         {
             var environment = TestEnvironmentFactory.GetTestEnvironment();
             string tenantId = null;
@@ -224,7 +224,7 @@ private GraphRbacManagementClient GetGraphClient(MockContext context)
                 }
             }
 
-            var client = context.GetGraphServiceClient<GraphRbacManagementClient>(environment);
+            var client = context.GetGraphServiceClient<MicrosoftGraphClient>(environment, true);
             client.TenantID = tenantId;
             if (AzureRmProfileProvider.Instance != null &&
                 AzureRmProfileProvider.Instance.Profile != null &&

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestGetCloudEndpoint.json

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Migrated Azure AD features in Az.StorageSync to MSGraph APIs. The cmdlets will call MSGraph API according to input parameters: New-AzStorageSyncCloudEndpoint
 * Changed default parameter set of Invoke-AzStorageSyncChangeDetection to use full share detection
 
 ## Version 1.6.1

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestGetCloudEndpointParentObject.json

@@ -12,13 +12,13 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Commands.StorageSync.Common;
 
 using Microsoft.Azure.Commands.StorageSync.Common.Extensions;
 using Microsoft.Azure.Commands.StorageSync.Models;
 using Microsoft.Azure.Commands.StorageSync.Properties;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01.Models;
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 using Microsoft.Azure.Management.StorageSync;
@@ -211,7 +211,12 @@ public override void ExecuteCmdlet()
                     }
                 }
 
-                PSADServicePrincipal servicePrincipal = StorageSyncClientWrapper.EnsureServicePrincipal();
+                MicrosoftGraphServicePrincipal servicePrincipal = StorageSyncClientWrapper.GetServicePrincipalOrNull();
+
+                if (servicePrincipal == null)
+                {
+                    throw new PSArgumentException(StorageSyncResources.MissingServicePrincipalResourceIdErrorMessage);
+                }
                 RoleAssignment roleAssignment = StorageSyncClientWrapper.EnsureRoleAssignment(servicePrincipal, storageAccountResourceIdentifier.Subscription, StorageAccountResourceId);
 
                 var parentResourceIdentifier = default(ResourceIdentifier);

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestGetCloudEndpointParentResourceId.json

@@ -12,12 +12,15 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using Microsoft.Azure.Commands.Common.Authentication;
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0;
+using Microsoft.Azure.Commands.ResourceManager.Common;
 using Microsoft.Azure.Commands.ResourceManager.Common.Properties;
 using Microsoft.Azure.Commands.StorageSync.Common.Converters;
 using Microsoft.Azure.Commands.StorageSync.Common.Exceptions;
 using Microsoft.Azure.Commands.StorageSync.Interfaces;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory;
+using Microsoft.Rest;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -40,13 +43,20 @@ public interface IStorageSyncClientCmdlet
 
     /// <summary>
     /// Class StorageSyncClientCmdletBase.
-    /// Implements the <see cref="Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory.ActiveDirectoryBaseCmdlet" />
     /// Implements the <see cref="Microsoft.Azure.Commands.StorageSync.Common.IStorageSyncClientCmdlet" />
     /// </summary>
-    /// <seealso cref="Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory.ActiveDirectoryBaseCmdlet" />
     /// <seealso cref="Microsoft.Azure.Commands.StorageSync.Common.IStorageSyncClientCmdlet" />
-    public abstract class StorageSyncClientCmdletBase : ActiveDirectoryBaseCmdlet, IStorageSyncClientCmdlet
+    public abstract class StorageSyncClientCmdletBase : AzureRMCmdlet, IStorageSyncClientCmdlet
     {
+        private MicrosoftGraphClient microsoftGraphClient;
+
+        public MicrosoftGraphClient MicrosoftGraphClient =>
+            microsoftGraphClient ?? (microsoftGraphClient = BuildClient<MicrosoftGraphClient>(endpoint: AzureEnvironment.ExtendedEndpoint.MicrosoftGraphUrl, postBuild: instance =>
+            {
+                instance.TenantID = DefaultContext.Tenant.Id;
+                return instance;
+            }));
+
         /// <summary>
         /// The production arm service host
         /// </summary>
@@ -131,7 +141,7 @@ public IStorageSyncClientWrapper StorageSyncClientWrapper
             {
                 if (storageSyncClientWrapper == null)
                 {
-                    storageSyncClientWrapper = new StorageSyncClientWrapper(AzureContext, ActiveDirectoryClient);
+                    storageSyncClientWrapper = new StorageSyncClientWrapper(AzureContext, MicrosoftGraphClient);
                 }
 
                 storageSyncClientWrapper.VerboseLogger = WriteVerboseWithTimestamp;
@@ -262,5 +272,12 @@ protected void WriteObject(IEnumerable<StorageSyncModels.ServerEndpoint> resourc
         {
             WriteObject(resources.Select(new ServerEndpointConverter().Convert), true);
         }
+
+        private T BuildClient<T>(string endpoint = null, Func<T, T> postBuild = null) where T : ServiceClient<T>
+        {
+            var instance = AzureSession.Instance.ClientFactory.CreateArmClient<T>(
+                DefaultProfile.DefaultContext, endpoint ?? AzureEnvironment.Endpoint.ResourceManager);
+            return postBuild == null ? instance : postBuild(instance);
+        }
     }
 }

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestGetCloudEndpoints.json

@@ -16,8 +16,10 @@
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
 using Microsoft.Azure.Commands.StorageSync.Interfaces;
 using Microsoft.Azure.Commands.StorageSync.Properties;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326.Models;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Users.Models;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01.Models;
 using Microsoft.Azure.Management.Internal.Resources;
@@ -55,11 +57,6 @@ public class StorageSyncClientWrapper : IStorageSyncClientWrapper
 
         private static Guid AzureUSGovernmentKailaniAppId = new Guid("ce88d19b-f69a-4c2e-ac8a-d1aa9db611e8");
 
-        /// <summary>
-        /// The azure us product test kailani application identifier
-        /// </summary>
-        private static Guid AzureUSProdTestKailaniAppId = new Guid("1fcdfafe-959b-4b32-afff-84f850974e84");
-
         /// <summary>
         /// The built in role definition identifier
         /// </summary>
@@ -90,10 +87,10 @@ public class StorageSyncClientWrapper : IStorageSyncClientWrapper
         public IResourceManagementClient ResourceManagementClient { get; set; }
 
         /// <summary>
-        /// Gets or sets the active directory client.
+        /// Gets or sets the Microsoft Graph Client.
         /// </summary>
-        /// <value>The active directory client.</value>
-        public ActiveDirectoryClient ActiveDirectoryClient { get; set; }
+        /// <value>The Microsoft Graph client.</value>
+        public MicrosoftGraphClient MicrosoftGraphClient { get; set; }
 
         /// <summary>
         /// Gets or sets the verbose logger.
@@ -112,12 +109,12 @@ public class StorageSyncClientWrapper : IStorageSyncClientWrapper
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="activeDirectoryClient">The active directory client.</param>
-        public StorageSyncClientWrapper(IAzureContext context, ActiveDirectoryClient activeDirectoryClient)
+        public StorageSyncClientWrapper(IAzureContext context, MicrosoftGraphClient microsoftGraphClient)
                 : this(AzureSession.Instance.ClientFactory.CreateArmClient<StorageSyncManagementClient>(context, AzureEnvironment.Endpoint.ResourceManager),
                       AzureSession.Instance.ClientFactory.CreateArmClient<AuthorizationManagementClient>(context, AzureEnvironment.Endpoint.ResourceManager),
                       AzureSession.Instance.ClientFactory.CreateArmClient<ResourceManagementClient>(context, AzureEnvironment.Endpoint.ResourceManager))
         {
-            ActiveDirectoryClient = activeDirectoryClient;
+            MicrosoftGraphClient = microsoftGraphClient;
 
             if (AzureSession.Instance.TryGetComponent(StorageSyncConstants.StorageSyncResourceManager, out IStorageSyncResourceManager storageSyncResourceManager))
             {
@@ -181,21 +178,13 @@ public Guid CurrentApplicationId
         {
             get
             {
-                if (StorageSyncConstants.ResourceProvider.EndsWith("Int", StringComparison.InvariantCultureIgnoreCase) ||
-                    StorageSyncConstants.ResourceProvider.EndsWith("Dev", StringComparison.InvariantCultureIgnoreCase))
-                {
-                    return AzureUSProdTestKailaniAppId;
-                }
-                else
-                {
                     switch (AzureRmProfileProvider.Instance?.Profile?.DefaultContext?.Environment?.Name)
                     {
                         case EnvironmentName.AzureUSGovernment:
                             return AzureUSGovernmentKailaniAppId;
                         default:
                             return AzureCloudKailaniAppId;
                     }
-                }
             }
         }
 
@@ -231,37 +220,17 @@ public string AfsAgentVersion
         /// Ensures the service principal.
         /// </summary>
         /// <returns>PSADServicePrincipal.</returns>
-        public PSADServicePrincipal EnsureServicePrincipal()
+        public MicrosoftGraphServicePrincipal GetServicePrincipalOrNull()
         {
             string applicationId = CurrentApplicationId.ToString();
-            string appObjectId = ActiveDirectoryClient.GetServicePrincipalsIdByAppId(CurrentApplicationId);
-            PSADServicePrincipal servicePrincipal = ActiveDirectoryClient.GetServicePrincipalByObjectId(appObjectId);
+            // TODO: Remove this call once Az Powershell supports MSGraphClient in Test framework.
+            MicrosoftGraphServicePrincipal servicePrincipal = this.StorageSyncResourceManager.GetServicePrincipalOrNull();
 
             if (servicePrincipal == null)
             {
-                VerboseLogger.Invoke(StorageSyncResources.CreateServicePrincipalMessage);
-                // Create an application and get the applicationId
-                var passwordCredential = new PSADPasswordCredential()
-                {
-                    StartDate = DateTime.Now,
-                    EndDate = DateTime.Now.AddYears(1),
-                    KeyId = Guid.NewGuid(),
-                    Password = SecureStringExtensions.ConvertToString(Guid.NewGuid().ToString().ConvertToSecureString())
-                };
-
-                var createParameters = new CreatePSServicePrincipalParameters
-                {
-                    ApplicationId = CurrentApplicationId,
-                    AccountEnabled = bool.TrueString,
-                    PasswordCredentials = new PSADPasswordCredential[]
-                     {
-                        passwordCredential
-                     }
-                };
-
-                servicePrincipal = ActiveDirectoryClient.CreateServicePrincipal(createParameters);
+                var oDataQuery = new ODataQuery<MicrosoftGraphServicePrincipal>(sp => sp.AppId == applicationId);
+                servicePrincipal = MicrosoftGraphClient.FilterServicePrincipals(oDataQuery).FirstOrDefault();
             }
-
             return servicePrincipal;
         }
 
@@ -273,7 +242,7 @@ public PSADServicePrincipal EnsureServicePrincipal()
         /// <param name="storageAccountSubscriptionId">The storage account subscription identifier.</param>
         /// <param name="storageAccountResourceId">The storage account resource identifier.</param>
         /// <returns>RoleAssignment.</returns>
-        public RoleAssignment EnsureRoleAssignment(PSADServicePrincipal serverPrincipal, string storageAccountSubscriptionId, string storageAccountResourceId)
+        public RoleAssignment EnsureRoleAssignment(MicrosoftGraphServicePrincipal serverPrincipal, string storageAccountSubscriptionId, string storageAccountResourceId)
         {
             string currentSubscriptionId = AuthorizationManagementClient.SubscriptionId;
             bool hasMismatchSubscription = currentSubscriptionId != storageAccountSubscriptionId;

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestNewCloudEndpoint.json

@@ -15,6 +15,7 @@
 using Commands.StorageSync.Interop.Clients;
 using Commands.StorageSync.Interop.DataObjects;
 using Commands.StorageSync.Interop.Interfaces;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
 using Microsoft.Azure.Commands.StorageSync.Interfaces;
 using Microsoft.Win32;
 using System;
@@ -101,5 +102,11 @@ public void Wait()
         /// </summary>
         /// <returns>System.String.</returns>
         public string GetTenantId() => null;
+
+        /// <summary>
+        /// Get Service Principal Or Null
+        /// </summary>
+        /// <returns>MicrosoftGraphServicePrincipal</returns>
+        public MicrosoftGraphServicePrincipal GetServicePrincipalOrNull() => null;
     }
 }

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestRemoveCloudEndpoint.json

@@ -13,7 +13,10 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
-using Microsoft.Azure.Graph.RBAC.Version1_6_20190326.ActiveDirectory;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Users.Models;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01;
 using Microsoft.Azure.Management.Authorization.Version2015_07_01.Models;
 using Microsoft.Azure.Management.Internal.Resources;
@@ -30,10 +33,10 @@ public interface IStorageSyncClientWrapper
     {
 
         /// <summary>
-        /// Gets or sets the active directory client.
+        /// Gets or sets the Microsoft Graph Client.
         /// </summary>
-        /// <value>The active directory client.</value>
-        ActiveDirectoryClient ActiveDirectoryClient { get; set; }
+        /// <value>The Microsoft Graph client.</value>
+        MicrosoftGraphClient MicrosoftGraphClient { get; set; }
 
         /// <summary>
         /// Gets or sets the storage sync management client.
@@ -75,7 +78,7 @@ public interface IStorageSyncClientWrapper
         /// Ensures the service principal.
         /// </summary>
         /// <returns>PSADServicePrincipal.</returns>
-        PSADServicePrincipal EnsureServicePrincipal();
+        MicrosoftGraphServicePrincipal GetServicePrincipalOrNull();
 
         /// <summary>
         /// Ensures the role assignment.
@@ -84,7 +87,7 @@ public interface IStorageSyncClientWrapper
         /// <param name="storageAccountSubscriptionId">The storage account subscription identifier.</param>
         /// <param name="storageAccountResourceId">The storage account resource identifier.</param>
         /// <returns>RoleAssignment.</returns>
-        RoleAssignment EnsureRoleAssignment(PSADServicePrincipal serverPrincipal, string storageAccountSubscriptionId, string storageAccountResourceId);
+        RoleAssignment EnsureRoleAssignment(MicrosoftGraphServicePrincipal serverPrincipal, string storageAccountSubscriptionId, string storageAccountResourceId);
 
         /// <summary>
         /// This function will invoke the registration and continue operation with a success function call.

src/StorageSync/StorageSync.Test/SessionRecords/StorageSyncTests.CloudEndpointTests/TestRemoveCloudEndpointInputObject.json

@@ -14,6 +14,7 @@
 
 using Commands.StorageSync.Interop.DataObjects;
 using Commands.StorageSync.Interop.Interfaces;
+using Microsoft.Azure.Commands.Common.MSGraph.Version1_0.Applications.Models;
 using System;
 
 namespace Microsoft.Azure.Commands.StorageSync.Interfaces
@@ -23,6 +24,12 @@ namespace Microsoft.Azure.Commands.StorageSync.Interfaces
     /// </summary>
     public interface IStorageSyncResourceManager
     {
+        /// <summary>
+        /// Get Service Principal Or Null
+        /// </summary>
+        /// <returns>MicrosoftGraphServicePrincipal</returns>
+        MicrosoftGraphServicePrincipal GetServicePrincipalOrNull();
+
         /// <summary>
         /// Creates the ecs management.
         /// </summary>