Add -Force parameter on Publish-AzBicepModule (#21713)

Author: SimonWahlin

src/Resources/ResourceManager/Implementation/Bicep/PublishAzureBicepModuleCmdlet.cs

@@ -33,12 +33,15 @@ public class PublishAzureBicepModuleCmdlet : AzureRMCmdlet
         [Parameter(Mandatory = false, HelpMessage = "Documentation uri of the Bicep module.")]
         public string DocumentationUri { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage="Overwrite existing published module.")]
+        public SwitchParameter Force { get; set; }
+
         [Parameter(Mandatory = false, HelpMessage="Indicates that this cmdlet returns a boolean result. By default, this cmdlet does not generate any output.")]
         public SwitchParameter PassThru { get; set; }
 
         public override void ExecuteCmdlet()
         {
-            BicepUtility.PublishFile(this.TryResolvePath(this.FilePath), this.Target, this.DocumentationUri, this.WriteVerbose, this.WriteWarning);
+            BicepUtility.PublishFile(this.TryResolvePath(this.FilePath), this.Target, this.DocumentationUri, this.Force.IsPresent, this.WriteVerbose, this.WriteWarning);
 
             if (this.PassThru.IsPresent)
             {

src/Resources/ResourceManager/Utilities/BicepUtility.cs

@@ -32,6 +32,8 @@ internal static class BicepUtility
 
         private const string MinimalVersionRequirementForBicepPublishWithOptionalDocumentationUriParameter = "0.14.46";
 
+        private const string MinimalVersionRequirementForBicepPublishWithOptionalForceParameter = "0.17.1";
+
         private const string MinimalVersionRequirementForBicepparamFileBuild = "0.16.1";
 
         public delegate void OutputCallback(string msg);
@@ -84,24 +86,26 @@ public static string BuildParamFile(string bicepParamFilePath, OutputCallback wr
             return buildResultPath;
         }
 
-        public static void PublishFile(string bicepFilePath, string target, string documentationUri = null, OutputCallback writeVerbose = null, OutputCallback writeWarning = null)
+        public static void PublishFile(string bicepFilePath, string target, string documentationUri = null, bool force = false, OutputCallback writeVerbose = null, OutputCallback writeWarning = null)
         {
             if (!FileUtilities.DataStore.FileExists(bicepFilePath))
             {
                 throw new AzPSArgumentException(Properties.Resources.InvalidBicepFilePath, "File");
             }
 
-            string bicepPublishCommand;
-
+            string bicepPublishCommand = $"bicep publish '{bicepFilePath}' --target '{target}'";
             if (!string.IsNullOrWhiteSpace(documentationUri))
             {
                 CheckMinimalVersionRequirement(MinimalVersionRequirementForBicepPublishWithOptionalDocumentationUriParameter);
-                bicepPublishCommand = $"bicep publish '{bicepFilePath}' --target '{target}' --documentationUri '{documentationUri}'";
+                bicepPublishCommand += $" --documentationUri '{documentationUri}'";
             }
-            else
+
+            if (force)
             {
-                bicepPublishCommand = $"bicep publish '{bicepFilePath}' --target '{target}'";
+                CheckMinimalVersionRequirement(MinimalVersionRequirementForBicepPublishWithOptionalForceParameter);
+                bicepPublishCommand += $" --force";
             }
+            
 
             RunBicepCommand(bicepPublishCommand, MinimalVersionRequirementForBicepPublish, writeVerbose, writeWarning);
         }

src/Resources/Resources/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Added `-Force` parameter on `Publish-AzBicepModule` for supporting overwriting existing modules. 
 * Fixed `New-AzADApplication` when multiple redirect url types are provided. [#21108]
 * Fixed `Update-AzADServicePrincipal` when empty array passed for `IdentifierUri` [#21345]
 * Fixed an issue where location header was missing in the response from the service for New-AzManagedApplication.

src/Resources/Resources/help/Publish-AzBicepModule.md

@@ -13,7 +13,7 @@ Publishes a Bicep file to a registry.
 ## SYNTAX
 
 ```
-Publish-AzBicepModule -FilePath <String> -Target <String> [-DocumentationUri <String>] [-PassThru]
+Publish-AzBicepModule -FilePath <String> -Target <String> [-DocumentationUri <String>] [-Force] [-PassThru]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -29,6 +29,13 @@ Publish-AzBicepModule -FilePath 'main.bicep' -Target 'br:{registry}/{moduleName}
 
 Publishes `main.bicep` to `br:{registry}/{moduleName}:{tag}`.
 
+### Example 2
+```powershell
+Publish-AzBicepModule -FilePath 'main.bicep' -Target 'br:{registry}/{moduleName}:{tag}' -Force
+```
+
+Publishes `main.bicep` to `br:{registry}/{moduleName}:{tag}`, overwriting existing version.
+
 ## PARAMETERS
 
 ### -DefaultProfile
@@ -75,6 +82,20 @@ Default value: None
 Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
+### -Force
+Allows overwriting of existing module.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
 
 ### -PassThru
 Indicates that this cmdlet returns a boolean result. By default, this cmdlet does not generate any output.