Adding powershell capability to bicep export (#28014)

anamikapan · web-flow · commit ab6490a778e9 · 2025-07-17T14:14:58.000+08:00
diff --git a/src/Resources/ResourceManager/Entities/ResourceGroup/ExportTemplateParameters.cs b/src/Resources/ResourceManager/Entities/ResourceGroup/ExportTemplateParameters.cs
@@ -32,5 +32,10 @@ public class ExportTemplateParameters
         /// </summary>
         [JsonProperty(Required = Required.Always)]
         public string[] Resources { get; set; }
+
+        /// <summary>
+        /// Gets or sets the output format.
+        /// </summary>
+        public string OutputFormat { get; set; }
     }
 }
diff --git a/src/Resources/ResourceManager/Implementation/ResourceGroups/ExportAzureResourceGroupCmdlet.cs b/src/Resources/ResourceManager/Implementation/ResourceGroups/ExportAzureResourceGroupCmdlet.cs
@@ -96,6 +96,13 @@ public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVe
         [ValidateNotNullOrEmpty]
         public override string ApiVersion { get; set; }
 
+        /// <summary>
+        /// Gets or sets the output format.
+        /// </summary>
+        [Parameter(Mandatory = false, HelpMessage = "The output format of the template. Allowed values are 'Json', 'Bicep'.")]
+        [ValidateSet(ExportTemplateOutputFormat.Json, ExportTemplateOutputFormat.Bicep, IgnoreCase = true)]
+        public string OutputFormat { get; set; } = ExportTemplateOutputFormat.Json;
+
         /// <summary>
         /// Executes the cmdlet.
         /// </summary>
@@ -106,7 +113,6 @@ protected override void OnProcessRecord()
 
             if (ShouldProcess(ResourceGroupName, VerbsData.Export))
             {
-
                 var resourceGroupId = this.GetResourceGroupId();
 
                 if (! this.IsParameterBound(c => c.ApiVersion))
@@ -115,12 +121,13 @@ protected override void OnProcessRecord()
                     {
                         Resources = this.GetResourcesFilter(resourceGroupId: resourceGroupId),
                         Options = this.GetExportOptions(),
+                        OutputFormat = this.OutputFormat
                     };
 
                     var exportedTemplate = NewResourceManagerSdkClient.ExportResourceGroup(ResourceGroupName, parameters);
 
                     var template = exportedTemplate.Template;
-                    contents = template.ToString();
+                    contents = template?.ToString() ?? string.Empty;
 
                     var error = exportedTemplate.Error;
 
@@ -139,6 +146,7 @@ protected override void OnProcessRecord()
                     {
                         Resources = this.GetResourcesFilter(resourceGroupId: resourceGroupId),
                         Options = this.GetExportOptions(),
+                        OutputFormat = this.OutputFormat
                     };
                     var apiVersion = this.ApiVersion;
                     var operationResult = this.GetResourcesClient()
@@ -161,12 +169,13 @@ protected override void OnProcessRecord()
                         isResourceCreateOrUpdate: false)
                         .WaitOnOperation(operationResult: operationResult);
 
-                    var template = JToken.FromObject(JObject.Parse(resultString)["template"]);
-                    contents = template.ToString();
+                    var resultObject = JObject.Parse(resultString);
+                    var template = resultObject["template"];
+                    contents = template?.ToString() ?? string.Empty;
 
-                    if (JObject.Parse(resultString)["error"] != null)
+                    if (resultObject["error"] != null)
                     {
-                        if (JObject.Parse(resultString)["error"].TryConvertTo(out ExtendedErrorInfo error))
+                        if (resultObject["error"].TryConvertTo(out ExtendedErrorInfo error))
                         {
                             WriteWarning(string.Format("{0} : {1}", error.Code, error.Message));
                             foreach (var detail in error.Details)
@@ -177,6 +186,9 @@ protected override void OnProcessRecord()
                     }
                 }
 
+                // Determine the correct file extension based on OutputFormat
+                string extension = OutputFormat.Equals(ExportTemplateOutputFormat.Bicep, StringComparison.OrdinalIgnoreCase) ? ".bicep" : ".json";
+
                 string path = FileUtility.SaveTemplateFile(
                     templateName: this.ResourceGroupName,
                     contents: contents,
@@ -185,7 +197,9 @@ protected override void OnProcessRecord()
                             ? System.IO.Path.Combine(CurrentPath(), this.ResourceGroupName)
                             : this.TryResolvePath(this.Path),
                     overwrite: Force.IsPresent,
-                    shouldContinue: ShouldContinue);
+                    shouldContinue: ShouldContinue,
+                    extension: extension // Pass the extension
+                    );
 
                 WriteObject(PowerShellUtilities.ConstructPSObject(null, "Path", path));
             }
diff --git a/src/Resources/ResourceManager/Utilities/FileUtility.cs b/src/Resources/ResourceManager/Utilities/FileUtility.cs
@@ -35,8 +35,9 @@ public static class FileUtility
         /// <param name="outputPath">The file output path</param>
         /// <param name="overwrite">Overrides existing file</param>
         /// <param name="shouldContinue">The confirmation action</param>
+        /// <param name="extension">The file extension (defaults to .json)</param>
         /// <returns>The file path</returns>
-        public static string SaveTemplateFile(string templateName, string contents, string outputPath, bool overwrite, Func<string, string, bool> shouldContinue)
+        public static string SaveTemplateFile(string templateName, string contents, string outputPath, bool overwrite, Func<string, string, bool> shouldContinue, string extension = ".json")
         {
             StringBuilder finalOutputPath = new StringBuilder();
 
@@ -48,14 +49,14 @@ public static string SaveTemplateFile(string templateName, string contents, stri
 
             if (FileUtilities.IsValidDirectoryPath(outputPath))
             {
-                finalOutputPath.Append(Path.Combine(outputPath, templateName + ".json"));
+                finalOutputPath.Append(Path.Combine(outputPath, templateName + extension));
             }
             else
             {
                 finalOutputPath.Append(outputPath);
-                if (!outputPath.EndsWith(".json"))
+                if (!outputPath.EndsWith(extension))
                 {
-                    finalOutputPath.Append(".json");
+                    finalOutputPath.Append(extension);
                 }
             }
 
diff --git a/src/Resources/Resources.Test/ScenarioTests/BicepExportTests.cs b/src/Resources/Resources.Test/ScenarioTests/BicepExportTests.cs
@@ -0,0 +1,29 @@
+using System.Management.Automation;
+using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Utilities;
+using Microsoft.Azure.Management.Resources.Models;
+using Microsoft.WindowsAzure.Commands.ScenarioTest;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Microsoft.Azure.Commands.Resources.Test.ScenarioTests
+{
+    public class BicepExportTests
+    {
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestFileUtilityBicepExtension()
+        {
+            // Test that the FileUtility.SaveTemplateFile method correctly uses the .bicep extension
+            var outputPath = FileUtility.SaveTemplateFile(
+                templateName: "test-template",
+                contents: "// Test bicep content\nresource test 'Microsoft.Storage/storageAccounts@2021-04-01' = {\n  name: 'test'\n}",
+                outputPath: System.IO.Path.GetTempPath(),
+                overwrite: true,
+                shouldContinue: null,
+                extension: ".bicep"
+            );
+            
+            Assert.EndsWith(".bicep", outputPath);
+        }
+    }
+}
diff --git a/src/Resources/Resources.Test/ScenarioTests/ResourceGroupTests.cs b/src/Resources/Resources.Test/ScenarioTests/ResourceGroupTests.cs
@@ -81,6 +81,13 @@ public void TestExportResourceGroup()
             TestRunner.RunTestScript("Test-ExportResourceGroup");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestExportResourceGroupBicep()
+        {
+            TestRunner.RunTestScript("Test-ExportResourceGroupBicep");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestExportResourceGroupAsyncRoute()
diff --git a/src/Resources/Resources.Test/ScenarioTests/ResourceGroupTests.ps1 b/src/Resources/Resources.Test/ScenarioTests/ResourceGroupTests.ps1
@@ -392,6 +392,37 @@ function Test-ExportResourceGroup
     }
 }
 
+<#
+.SYNOPSIS
+Tests export resource group template file as bicep.
+#>
+function Test-ExportResourceGroupBicep
+{
+	# Setup
+        $rgname = Get-ResourceGroupName
+        $rname = Get-ResourceName
+        $rglocation = Get-Location "Microsoft.Resources" "resourceGroups" "West US"
+        $apiversion = "2014-04-01"
+        $resourceType = "Providers.Test/statefulResources"
+
+        try {
+            # Test
+            New-AzResourceGroup -Name $rgname -Location $rglocation
+            
+            $r = New-AzResource -Name $rname -Location "centralus" -Tags @{ testtag = "testval" } -ResourceGroupName $rgname -ResourceType $resourceType -SkuObject @{ Name = "A0" } -ApiVersion $apiversion -Force
+            Assert-AreEqual $r.ResourceGroupName $rgname
+
+            $exportOutput = Export-AzResourceGroup -ResourceGroupName $rgname -OutputFormat Bicep -Force
+            Assert-NotNull $exportOutput
+            Assert-True { $exportOutput.Path.Contains($rgname + ".bicep") }
+        }
+        finally {
+            # Cleanup
+            Clean-ResourceGroup $rgname
+        }
+    }
+
+
 <#
 .SYNOPSIS
 Tests async export to export resource group template file.
diff --git a/src/Resources/Resources.Test/ScenarioTests/ResourcesTestRunner.cs b/src/Resources/Resources.Test/ScenarioTests/ResourcesTestRunner.cs
@@ -44,7 +44,7 @@ protected ResourcesTestRunner(ITestOutputHelper output)
                     helper.RMResourceModule,
                     helper.GetRMModulePath("Az.Monitor.psd1"),
                     helper.GetRMModulePath("Az.ManagedServiceIdentity.psd1"),
-                    helper.GetRMModulePath("Az.Purview.psd1")
+                    // helper.GetRMModulePath("Az.Purview.psd1") // Temporarily commented out due to type loading issue
                 })
                 .WithRecordMatcher(
                     (ignoreResourcesClient, resourceProviders, userAgentsToIgnore) => new ResourcesRecordMatcher(ignoreResourcesClient, resourceProviders, userAgentsToIgnore)
diff --git a/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroup.json b/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroup.json
diff --git a/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupAsyncRoute.json b/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupAsyncRoute.json
diff --git a/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupBicep.json b/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupBicep.json
diff --git a/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupWithFiltering.json b/src/Resources/Resources.Test/SessionRecords/Microsoft.Azure.Commands.Resources.Test.ScenarioTests.ResourceGroupTests/TestExportResourceGroupWithFiltering.json
diff --git a/src/Resources/Resources/ChangeLog.md b/src/Resources/Resources/ChangeLog.md
@@ -19,6 +19,9 @@
 -->
 
 ## Upcoming Release
+* Added support for exporting resource group templates as Bicep files
+    - Added `OutputFormat` parameter to `Export-AzResourceGroup` cmdlet
+    - Supported values: `Json` (default), `Bicep`
 
 ## Version 8.0.1
 * Fixed empty warning output issue for cmdlet `Test-AzResourceGroupDeployment` [#27888]
diff --git a/src/Resources/Resources/help/Export-AzResourceGroup.md b/src/Resources/Resources/help/Export-AzResourceGroup.md
@@ -16,12 +16,12 @@ Captures a resource group as a template and saves it to a file.
 ```
 Export-AzResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue]
  [-IncludeComments] [-SkipResourceNameParameterization] [-SkipAllParameterization] [-Resource <String[]>]
- [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>]
+ [-OutputFormat <String>] [-Force] [-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The **Export-AzResourceGroup** cmdlet captures the specified resource group as a template and saves it to a JSON file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments.
+The **Export-AzResourceGroup** cmdlet captures the specified resource group as a template and saves it to a JSON or Bicep file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments.
 This cmdlet gives you an easy start by generating the template for your existing resources in the resource group.
 There might be some cases where this cmdlet fails to generate some parts of the template.
 Warning messages will inform you of the resources that failed.
@@ -53,6 +53,20 @@ Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -
 
 This command captures two resources from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory. The generated template will not contain any generated parameters.
 
+### Example 4: Export a resource group as a Bicep file
+```powershell
+Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep
+```
+
+This command captures the resource group named TestGroup as a template, and saves it to a Bicep file in the current directory.
+
+### Example 5: Export a resource group as a Bicep file with custom path
+```powershell
+Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"
+```
+
+This command captures the resource group named TestGroup as a template, and saves it to a Bicep file at the specified path.
+
 ## PARAMETERS
 
 ### -ApiVersion
@@ -146,6 +160,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -OutputFormat
+Specifies the format of the exported template. Supported values are "Json" and "Bicep".
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: Json
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Pre
 Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use.
 

Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,10 @@ public class ExportTemplateParameters`
`32`	`32`	`/// </summary>`
`33`	`33`	`[JsonProperty(Required = Required.Always)]`
`34`	`34`	`public string[] Resources { get; set; }`
	`35`	`+`
	`36`	`+ /// <summary>`
	`37`	`+ /// Gets or sets the output format.`
	`38`	`+ /// </summary>`
	`39`	`+ public string OutputFormat { get; set; }`
`35`	`40`	`}`
`36`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,9 @@ public static class FileUtility`
`35`	`35`	`/// <param name="outputPath">The file output path</param>`
`36`	`36`	`/// <param name="overwrite">Overrides existing file</param>`
`37`	`37`	`/// <param name="shouldContinue">The confirmation action</param>`
	`38`	`+ /// <param name="extension">The file extension (defaults to .json)</param>`
`38`	`39`	`/// <returns>The file path</returns>`
`39`		`- public static string SaveTemplateFile(string templateName, string contents, string outputPath, bool overwrite, Func<string, string, bool> shouldContinue)`
	`40`	`+ public static string SaveTemplateFile(string templateName, string contents, string outputPath, bool overwrite, Func<string, string, bool> shouldContinue, string extension = ".json")`
`40`	`41`	`{`
`41`	`42`	`StringBuilder finalOutputPath = new StringBuilder();`
`42`	`43`
`@@ -48,14 +49,14 @@ public static string SaveTemplateFile(string templateName, string contents, stri`
`48`	`49`
`49`	`50`	`if (FileUtilities.IsValidDirectoryPath(outputPath))`
`50`	`51`	`{`
`51`		`- finalOutputPath.Append(Path.Combine(outputPath, templateName + ".json"));`
	`52`	`+ finalOutputPath.Append(Path.Combine(outputPath, templateName + extension));`
`52`	`53`	`}`
`53`	`54`	`else`
`54`	`55`	`{`
`55`	`56`	`finalOutputPath.Append(outputPath);`
`56`		`- if (!outputPath.EndsWith(".json"))`
	`57`	`+ if (!outputPath.EndsWith(extension))`
`57`	`58`	`{`
`58`		`- finalOutputPath.Append(".json");`
	`59`	`+ finalOutputPath.Append(extension);`
`59`	`60`	`}`
`60`	`61`	`}`
`61`	`62`