Updated Export-AzResourceGroup cmdlet to use the SDK. (Azure#13275)

* Export template with SDK #1

* Export template with SDK #2

* Update changelog

* Added back support for -ApiVersion parameter with a deprecation notice

* update changelog to avoid merge issue

* Review fixes

* re-record tests

Co-authored-by: Yeming Liu <[email protected]>

Author: Xynoclafe

src/Resources/ResourceManager/Implementation/CmdletBase/ResourceManagerCmdletBaseWithAPiVersion.cs

@@ -25,7 +25,7 @@ public abstract class ResourceManagerCmdletBaseWithApiVersion : ResourceManagerC
         /// </summary>
         [Parameter(Mandatory = false, HelpMessage = "When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.")]
         [ValidateNotNullOrEmpty]
-        public string ApiVersion { get; set; }
+        public virtual string ApiVersion { get; set; }
 
         private Dictionary<string, string> GetCmdletHeaders()
         {

src/Resources/ResourceManager/Implementation/ResourceGroups/ExportAzureResourceGroupCmdlet.cs

@@ -22,6 +22,8 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.ResourceIds;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Utilities;
+    using Microsoft.Azure.Management.ResourceManager.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using Microsoft.WindowsAzure.Commands.Utilities.Common;
     using Newtonsoft.Json.Linq;
     using System;
@@ -93,51 +95,43 @@ public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVe
         [Parameter(Mandatory = false, HelpMessage = "Do not ask for confirmation.")]
         public SwitchParameter Force { get; set; }
 
+        /// <summary>
+        /// Gets or sets the API version.
+        /// </summary>
+        [CmdletParameterBreakingChange("ApiVersion", ChangeDescription = "Parameter is being deprecated without being replaced. Using the lastest possible API version will become the default behavior.")]
+        [Parameter(Mandatory = false, HelpMessage = "When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.")]
+        [ValidateNotNullOrEmpty]
+        public override string ApiVersion { get; set; }
+
         /// <summary>
         /// Executes the cmdlet.
         /// </summary>
         protected override void OnProcessRecord()
         {
             base.OnProcessRecord();
+            string contents;
+
             if (ShouldProcess(ResourceGroupName, VerbsData.Export))
             {
 
                 var resourceGroupId = this.GetResourceGroupId();
 
-                var apiVersion = this.ApiVersion ?? DefaultApiVersion;
-
-                var parameters = new ExportTemplateParameters
-                {
-                    Resources = this.GetResourcesFilter(resourceGroupId: resourceGroupId),
-                    Options = this.GetExportOptions(),
-                };
-
-                var operationResult = this.GetResourcesClient()
-                    .InvokeActionOnResource<JObject>(
-                        resourceId: resourceGroupId,
-                        action: Constants.ExportTemplate,
-                        parameters: parameters.ToJToken(),
-                        apiVersion: apiVersion,
-                        cancellationToken: this.CancellationToken.Value)
-                    .Result;
-
-                var managementUri = this.GetResourcesClient()
-                    .GetResourceManagementRequestUri(
-                        resourceId: resourceGroupId,
-                        apiVersion: apiVersion,
-                        action: Constants.ExportTemplate);
-
-                var activity = string.Format("POST {0}", managementUri.PathAndQuery);
-                var resultString = this.GetLongRunningOperationTracker(activityName: activity,
-                    isResourceCreateOrUpdate: false)
-                    .WaitOnOperation(operationResult: operationResult);
-
-                var template = JToken.FromObject(JObject.Parse(resultString)["template"]);
-
-                if (JObject.Parse(resultString)["error"] != null)
+                if (this.IsParameterBound(c => c.ApiVersion))
                 {
-                    ExtendedErrorInfo error;
-                    if (JObject.Parse(resultString)["error"].TryConvertTo(out error))
+                    var parameters = new Management.ResourceManager.Models.ExportTemplateRequest
+                    {
+                        Resources = this.GetResourcesFilter(resourceGroupId: resourceGroupId),
+                        Options = this.GetExportOptions(),
+                    };
+
+                    var exportedTemplate = ResourceManagerSdkClient.ExportResourceGroup(ResourceGroupName, parameters);
+
+                    var template = exportedTemplate.Template;
+                    contents = template.ToString();
+
+                    var error = exportedTemplate.Error;
+
+                    if(error != null)
                     {
                         WriteWarning(string.Format("{0} : {1}", error.Code, error.Message));
                         foreach (var detail in error.Details)
@@ -146,10 +140,53 @@ protected override void OnProcessRecord()
                         }
                     }
                 }
+                else
+                {
+                    var parameters = new ExportTemplateParameters
+                    {
+                        Resources = this.GetResourcesFilter(resourceGroupId: resourceGroupId),
+                        Options = this.GetExportOptions(),
+                    };
+                    var apiVersion = this.ApiVersion ?? DefaultApiVersion;
+                    var operationResult = this.GetResourcesClient()
+                       .InvokeActionOnResource<JObject>(
+                           resourceId: resourceGroupId,
+                           action: Constants.ExportTemplate,
+                           parameters: parameters.ToJToken(),
+                           apiVersion: apiVersion,
+                           cancellationToken: this.CancellationToken.Value)
+                       .Result;
+
+                    var managementUri = this.GetResourcesClient()
+                        .GetResourceManagementRequestUri(
+                            resourceId: resourceGroupId,
+                            apiVersion: apiVersion,
+                            action: Constants.ExportTemplate);
+
+                    var activity = string.Format("POST {0}", managementUri.PathAndQuery);
+                    var resultString = this.GetLongRunningOperationTracker(activityName: activity,
+                        isResourceCreateOrUpdate: false)
+                        .WaitOnOperation(operationResult: operationResult);
+
+                    var template = JToken.FromObject(JObject.Parse(resultString)["template"]);
+                    contents = template.ToString();
+
+                    if (JObject.Parse(resultString)["error"] != null)
+                    {
+                        if (JObject.Parse(resultString)["error"].TryConvertTo(out ExtendedErrorInfo error))
+                        {
+                            WriteWarning(string.Format("{0} : {1}", error.Code, error.Message));
+                            foreach (var detail in error.Details)
+                            {
+                                WriteWarning(string.Format("{0} : {1}", detail.Code, detail.Message));
+                            }
+                        }
+                    }
+                }
 
                 string path = FileUtility.SaveTemplateFile(
                     templateName: this.ResourceGroupName,
-                    contents: template.ToString(),
+                    contents: contents,
                     outputPath:
                         string.IsNullOrEmpty(this.Path)
                             ? System.IO.Path.Combine(CurrentPath(), this.ResourceGroupName)

src/Resources/ResourceManager/SdkClient/ResourceManagerSdkClient.cs

@@ -178,6 +178,11 @@ private ResourceGroup CreateOrUpdateResourceGroup(string name, string location,
             return result;
         }
 
+        public ResourceGroupExportResult ExportResourceGroup(string resourceGroupName, ExportTemplateRequest properties)
+        {
+            return ResourceManagementClient.ResourceGroups.ExportTemplate(resourceGroupName, properties);
+        }
+
         private void WriteVerbose(string progress)
         {
             if (VerboseLogger != null)

src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroup.json

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Updated `Export-AzResourceGroup` to use the SDK.
 
 ## Version 3.0.0
 * Fixed parsing bug