Make Sha256Checksum optional in New-AzImageBuilderCustomizerObject (#12188)

* Make Sha256Checksum optional in `New-AzImageBuilderCustomizerObject`

* Make Sha256Checksum optional in `New-AzImageBuilderCustomizerObject`

Co-authored-by: wyunchi-ms <[email protected]>

Author: wyunchi-ms

src/ImageBuilder/Az.ImageBuilder.psd1

@@ -1,7 +1,7 @@
 @{
   GUID = 'bdedc683-d9b6-41ea-b310-d068b8c72305'
   RootModule = './Az.ImageBuilder.psm1'
-  ModuleVersion = '0.1.0'
+  ModuleVersion = '0.1.1'
   CompatiblePSEditions = 'Core', 'Desktop'
   Author = 'Microsoft Corporation'
   CompanyName = 'Microsoft Corporation'

src/ImageBuilder/ChangeLog.md

@@ -19,6 +19,9 @@
 -->
 ## Upcoming Release
 
+## Version 0.1.1
+* Made `Sha256Checksum` optional in `New-AzImageBuilderCustomizerObject`.
+
 ## Version 0.1.0
 * the first preview release
 

src/ImageBuilder/Properties/AssemblyInfo.cs

@@ -24,5 +24,5 @@
 [assembly: ComVisible(false)]
 [assembly: CLSCompliant(false)]
 [assembly: Guid("032C639A-AFE3-4DEE-8B70-6B920335732D")]
-[assembly: AssemblyVersion("0.1.0")]
-[assembly: AssemblyFileVersion("0.1.0")]
+[assembly: AssemblyVersion("0.1.1")]
+[assembly: AssemblyFileVersion("0.1.1")]

src/ImageBuilder/custom/New-AzImageBuilderCustomizerObject.ps1

@@ -41,9 +41,9 @@ function New-AzImageBuilderCustomizerObject {
         [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
         [string]
         ${ScriptUri},
-        [Parameter(ParameterSetName='ShellCustomizer', Mandatory, HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
-        [Parameter(ParameterSetName='FileCustomizer', Mandatory, HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
-        [Parameter(ParameterSetName='PowerShellCustomizer', Mandatory, HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
+        [Parameter(ParameterSetName='ShellCustomizer', HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
+        [Parameter(ParameterSetName='FileCustomizer', HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
+        [Parameter(ParameterSetName='PowerShellCustomizer', HelpMessage="SHA256 checksum of the shell script provided in the scriptUri field.")]
         [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
         [string]
         ${Sha256Checksum},

src/ImageBuilder/exports/New-AzImageBuilderCustomizerObject.ps1

@@ -67,14 +67,6 @@ param(
     # Friendly Name to provide context on what this customization step does.
     ${CustomizerName},
 
-    [Parameter(ParameterSetName='ShellCustomizer', Mandatory)]
-    [Parameter(ParameterSetName='PowerShellCustomizer', Mandatory)]
-    [Parameter(ParameterSetName='FileCustomizer', Mandatory)]
-    [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
-    [System.String]
-    # SHA256 checksum of the shell script provided in the scriptUri field.
-    ${Sha256Checksum},
-
     [Parameter(ParameterSetName='ShellCustomizer', Mandatory)]
     [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
     [System.Management.Automation.SwitchParameter]
@@ -98,6 +90,14 @@ param(
     # It can be a github link, SAS URI for Azure Storage, etc.
     ${ScriptUri},
 
+    [Parameter(ParameterSetName='ShellCustomizer')]
+    [Parameter(ParameterSetName='PowerShellCustomizer')]
+    [Parameter(ParameterSetName='FileCustomizer')]
+    [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
+    [System.String]
+    # SHA256 checksum of the shell script provided in the scriptUri field.
+    ${Sha256Checksum},
+
     [Parameter(ParameterSetName='PowerShellCustomizer', Mandatory)]
     [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
     [System.Management.Automation.SwitchParameter]

src/ImageBuilder/exports/ProxyCmdletDefinitions.ps1

@@ -1012,14 +1012,6 @@ param(
     # Friendly Name to provide context on what this customization step does.
     ${CustomizerName},
 
-    [Parameter(ParameterSetName='ShellCustomizer', Mandatory)]
-    [Parameter(ParameterSetName='PowerShellCustomizer', Mandatory)]
-    [Parameter(ParameterSetName='FileCustomizer', Mandatory)]
-    [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
-    [System.String]
-    # SHA256 checksum of the shell script provided in the scriptUri field.
-    ${Sha256Checksum},
-
     [Parameter(ParameterSetName='ShellCustomizer', Mandatory)]
     [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
     [System.Management.Automation.SwitchParameter]
@@ -1043,6 +1035,14 @@ param(
     # It can be a github link, SAS URI for Azure Storage, etc.
     ${ScriptUri},
 
+    [Parameter(ParameterSetName='ShellCustomizer')]
+    [Parameter(ParameterSetName='PowerShellCustomizer')]
+    [Parameter(ParameterSetName='FileCustomizer')]
+    [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
+    [System.String]
+    # SHA256 checksum of the shell script provided in the scriptUri field.
+    ${Sha256Checksum},
+
     [Parameter(ParameterSetName='PowerShellCustomizer', Mandatory)]
     [Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Category('Body')]
     [System.Management.Automation.SwitchParameter]

src/ImageBuilder/generated/runtime/BuildTime/Cmdlets/ExportPsd1.cs

@@ -49,7 +49,7 @@ protected override void ProcessRecord()
           throw new ArgumentException($"Custom folder '{CustomFolder}' does not exist");
         }
 
-        string version = Convert.ToString(@"0.1.0");
+        string version = Convert.ToString(@"0.1.1");
         // Validate the module version should be semantic version
         // Following regex is official from https://semver.org/
         Regex rx = new Regex(@"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$", RegexOptions.Compiled);

src/ImageBuilder/help/New-AzImageBuilderCustomizerObject.md

@@ -14,20 +14,20 @@ Describes a unit of image customization
 
 ### ShellCustomizer (Default)
 ```
-New-AzImageBuilderCustomizerObject -CustomizerName <String> -Sha256Checksum <String> -ShellCustomizer
- [-Inline <String[]>] [-ScriptUri <String>] [<CommonParameters>]
+New-AzImageBuilderCustomizerObject -CustomizerName <String> -ShellCustomizer [-Inline <String[]>]
+ [-ScriptUri <String>] [-Sha256Checksum <String>] [<CommonParameters>]
 ```
 
 ### FileCustomizer
 ```
-New-AzImageBuilderCustomizerObject -CustomizerName <String> -FileCustomizer -Sha256Checksum <String>
- [-Destination <String>] [-SourceUri <String>] [<CommonParameters>]
+New-AzImageBuilderCustomizerObject -CustomizerName <String> -FileCustomizer [-Destination <String>]
+ [-Sha256Checksum <String>] [-SourceUri <String>] [<CommonParameters>]
 ```
 
 ### PowerShellCustomizer
 ```
-New-AzImageBuilderCustomizerObject -CustomizerName <String> -PowerShellCustomizer -Sha256Checksum <String>
- [-Inline <String[]>] [-RunElevated <Boolean>] [-ScriptUri <String>] [-ValidExitCode <Int32[]>]
+New-AzImageBuilderCustomizerObject -CustomizerName <String> -PowerShellCustomizer [-Inline <String[]>]
+ [-RunElevated <Boolean>] [-ScriptUri <String>] [-Sha256Checksum <String>] [-ValidExitCode <Int32[]>]
  [<CommonParameters>]
 ```
 
@@ -320,7 +320,7 @@ Type: System.String
 Parameter Sets: FileCustomizer, PowerShellCustomizer, ShellCustomizer
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False

src/ImageBuilder/readme.md

@@ -53,7 +53,7 @@ input-file:
   - $(repo)/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json
 
 title: ImageBuilder
-module-version: 0.1.0
+module-version: 0.1.1
 subject-prefix: ''
 
 identity-correction-for-post: true