Make Sha256Checksum optional in New-AzImageBuilderCustomizerObject (#12179)

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

Author: wyunchi-ms

src/ImageBuilder/custom/Az.ImageBuilder.custom.psm1

@@ -1,9 +1,9 @@
 # region Generated 
   # Load the private module dll
-  $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.ImageBuilder.private.dll')
+  $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.ImageBuilder.private.dll')
 
   # Load the internal module
-  $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.ImageBuilder.internal.psm1'
+  $internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.ImageBuilder.internal.psm1'
   if(Test-Path $internalModulePath) {
     $null = Import-Module -Name $internalModulePath
   }

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/custom/readme.md

@@ -1,5 +1,5 @@
 # Custom
-This directory contains custom implementation for non-generated cmdlets for the `Az.ImageBuilder` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.ImageBuilder.custom.psm1`. This file should not be modified.
+This directory contains custom implementation for non-generated cmdlets for the `Az.ImageBuilder` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.ImageBuilder.custom.psm1`. This file should not be modified.
 
 ## Info
 - Modifiable: yes
@@ -15,10 +15,10 @@ For C# cmdlets, they are compiled with the rest of the generated low-level cmdle
 For script cmdlets, these are loaded via the `Az.ImageBuilder.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundemental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
 
 ## Purpose
-This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder.
+This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
 
 ## Usage
-The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
+The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
 - Break
 - DefaultProfile
 - HttpPipelineAppend
@@ -36,6 +36,6 @@ For processing the cmdlets, we've created some additional attributes:
 - `Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.DoNotExportAttribute`
   - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.ImageBuilder`.
 - `Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.InternalExportAttribute`
-  - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.ImageBuilder`. For more information, see [readme.md](../internal/readme.md) in the `../internal` folder.
+  - Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.ImageBuilder`. For more information, see [readme.md](..\internal/readme.md) in the `..\internal` folder.
 - `Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.ProfileAttribute`
   - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.

src/ImageBuilder/docs/Az.ImageBuilder.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.ImageBuilder
-Module Guid: aab8c8e8-8e05-4f5f-af3c-0f2aa5cc1648
+Module Guid: bdedc683-d9b6-41ea-b310-d068b8c72305
 Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.imagebuilder
 Help Version: 1.0.0.0
 Locale: en-US

src/ImageBuilder/docs/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/docs/readme.md

@@ -1,5 +1,5 @@
 # Docs
-This directory contains the documentation of the cmdlets for the `Az.ImageBuilder` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overriden on regeneration*. To update documentation examples, please use the `../examples` folder.
+This directory contains the documentation of the cmdlets for the `Az.ImageBuilder` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overriden on regeneration*. To update documentation examples, please use the `..\examples` folder.
 
 ## Info
 - Modifiable: no
@@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.ImageBuilde
 - Packaged: yes
 
 ## Details
-The process of documentation generation loads `Az.ImageBuilder` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.
+The process of documentation generation loads `Az.ImageBuilder` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder.

src/ImageBuilder/test/readme.md

@@ -1,5 +1,5 @@
 # Test
-This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets.
+This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `..\custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets.
 
 ## Info
 - Modifiable: yes