Upgrade spec to 5.6.0 (#79)

Author: dingmeng-xue

docs/how-to-update-az-module-spec.md

@@ -44,15 +44,15 @@ Have the following installed on your system:
 
    ```powershell
    # setup
-   $azModuleVersion = '5.5.0'
+   $azModuleVersion = '5.6.0'
 
    # execute
    .\powershell-module\Scripts\New-AzCmdletSpec.ps1 -AzVersion $azModuleVersion -OutputDirectory (Join-Path -Path (Get-Location) -ChildPath 'powershell-module\Az.Tools.Migration\Resources\ModuleSpecs\Az\'$azModuleVersion)
    ```
 
 1. Update the Az PowerShell module version listed in documentation, function help, function
    parameter validation, and unit tests. The easiest way to do this is to perform a search to find
-   and replace the old version. For example, search for '5.2.0' and replace with '5.5.0'.
+   and replace the old version. For example, search for '5.2.0' and replace with '5.6.0'.
 
 1. Remove the old module spec files from module resources:
    `powershell-module\Az.Tools.Migration\Resources\ModuleSpecs\Az\{old-version}`.

docs/quickstart-migrate-azurerm-to-az-automatically.md

@@ -44,12 +44,12 @@ points that require changes when moving from AzureRM to the Az PowerShell cmdlet
 
 ```powershell
 #  Generate an upgrade plan for the specified PowerShell script and save it to a variable.
-$Plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -FilePath 'C:\Scripts\my-azure-script.ps1'
+$Plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -FilePath 'C:\Scripts\my-azure-script.ps1'
 ```
 
 ```powershell
 # Generate an upgrade plan for all the scripts and module files in the specified folder and save it to a variable.
-$Plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -DirectoryPath 'C:\Scripts'
+$Plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -DirectoryPath 'C:\Scripts'
 ```
 
 Review the results of the upgrade plan.
@@ -106,7 +106,7 @@ $Results | Where-Object UpgradeResult -ne UpgradeCompleted | Format-List
 
 * File I/O operations use default encoding. Unusual file encoding situations may cause problems.
 * AzureRM cmdlets passed as arguments to Pester unit test mock statements aren't detected.
-* Currently, only Az PowerShell module version 5.5.0 is supported as a target.
+* Currently, only Az PowerShell module version 5.6.0 is supported as a target.
 
 ## Next steps
 

powershell-module/Az.Tools.Migration/Az.Tools.Migration.psd1

@@ -3,7 +3,7 @@
     RootModule = 'Az.Tools.Migration.psm1'
 
     # Version number of this module.
-    ModuleVersion = '1.0.0'
+    ModuleVersion = '1.1.0'
 
     # Supported PSEditions
     CompatiblePSEditions = 'Core', 'Desktop'
@@ -108,8 +108,11 @@
             # IconUri = ''
 
             # ReleaseNotes of this module
-            ReleaseNotes = '* General availability of ''Az.Tools.Migration'' module
-            * Upgraded Az version to 5.2'
+            ReleaseNotes = '* Upgrade Az version to 5.6.0
+            * Fixed a bug where New-AzUpgradeModulePlan throws errors when analyzing hashtable code (issue #73).
+            * Updated scanning results for Az cmdlets that implement dynamic parameters to use clearer warnings.
+            * Updated Get-AzUpgradeCmdletSpec to improve performance.
+            * Updated quickstart guide to remove outdated guidance on splatted parameter detection.'
         }
     }
 

powershell-module/Az.Tools.Migration/Functions/Public/Get-AzUpgradeAliasSpec.ps1

@@ -11,8 +11,8 @@ function Get-AzUpgradeAliasSpec
         Specify the version of the module to import command aliases from.
 
     .EXAMPLE
-        PS C:\> Get-AzUpgradeAliasSpec -ModuleVersion "5.5.0"
-        Returns the cmdlet alias mappings table for Az 5.5.0.
+        PS C:\> Get-AzUpgradeAliasSpec -ModuleVersion "5.6.0"
+        Returns the cmdlet alias mappings table for Az 5.6.0.
     #>
     [CmdletBinding()]
     Param

powershell-module/Az.Tools.Migration/Functions/Public/Invoke-AzUpgradeModulePlan.ps1

@@ -23,7 +23,7 @@ function Invoke-AzUpgradeModulePlan
         The following example invokes the upgrade plan for a PowerShell module named "myModule" and saves the updated file contents into new files (leaving original files unmodified).
 
         # step 1: generate a plan and save it to a variable.
-        $plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -DirectoryPath 'C:\Scripts\myModule'
+        $plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -DirectoryPath 'C:\Scripts\myModule'
 
         # step 2: write the plan to the console to review the upgrade steps, warnings, and errors.
         $plan
@@ -38,7 +38,7 @@ function Invoke-AzUpgradeModulePlan
         The following example invokes the upgrade plan for a PowerShell module named "myModule" and modifies the existing files in place.
 
         # step 1: generate a plan and save it to a variable.
-        $plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -DirectoryPath 'C:\Scripts\myModule'
+        $plan = New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -DirectoryPath 'C:\Scripts\myModule'
 
         # step 2: write the plan to the console to review the upgrade steps, warnings, and errors.
         $plan

powershell-module/Az.Tools.Migration/Functions/Public/New-AzUpgradeModulePlan.ps1

@@ -11,7 +11,7 @@ function New-AzUpgradeModulePlan
         Specifies the AzureRM module version used in your existing PowerShell scripts(s) or modules.
 
     .PARAMETER ToAzVersion
-        Specifies the Az module version to upgrade to. Currently, only Az version 5.5.0 is supported.
+        Specifies the Az module version to upgrade to. Currently, only Az version 5.6.0 is supported.
 
     .PARAMETER FilePath
         Specifies the path to a single PowerShell file.
@@ -34,32 +34,32 @@ function New-AzUpgradeModulePlan
     .EXAMPLE
         The following example generates a new Az module upgrade plan for the script file 'C:\Scripts\my-azure-script.ps1'.
 
-        New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -FilePath 'C:\Scripts\my-azure-script.ps1'
+        New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -FilePath 'C:\Scripts\my-azure-script.ps1'
 
     .EXAMPLE
         The following example generates a new Az module upgrade plan for the script and module files located under C:\Scripts.
 
-        New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.5.0 -DirectoryPath 'C:\Scripts'
+        New-AzUpgradeModulePlan -FromAzureRmVersion 6.13.1 -ToAzVersion 5.6.0 -DirectoryPath 'C:\Scripts'
 
     .EXAMPLE
         The following example generates a new Az module upgrade plan for the script and module files under C:\Scripts.
 
         $references = Find-AzUpgradeCommandReference -DirectoryPath 'C:\Scripts' -AzureRmVersion '6.13.1'
-        New-AzUpgradeModulePlan -ToAzVersion 5.5.0 -AzureRmCmdReference $references
+        New-AzUpgradeModulePlan -ToAzVersion 5.6.0 -AzureRmCmdReference $references
 
     .EXAMPLE
         The following example generates a new Az module upgrade plan for the script and module files under several directories.
         Module specs are pre-loaded here to avoid re-loading the spec each time a plan is generated.
 
         # pre-load specifications
         $armSpec = Get-AzUpgradeCmdletSpec -ModuleName "AzureRM" -ModuleVersion "6.13.1"
-        $azSpec = Get-AzUpgradeCmdletSpec -ModuleName "Az" -ModuleVersion "5.5.0"
-        $azAliases = Get-AzUpgradeAliasSpec -ModuleVersion "5.5.0"
+        $azSpec = Get-AzUpgradeCmdletSpec -ModuleName "Az" -ModuleVersion "5.6.0"
+        $azAliases = Get-AzUpgradeAliasSpec -ModuleVersion "5.6.0"
 
         # execute a batch of module upgrades
-        $plan1 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts1' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.5.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
-        $plan2 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts2' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.5.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
-        $plan3 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts3' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.5.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
+        $plan1 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts1' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.6.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
+        $plan2 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts2' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.6.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
+        $plan3 = New-AzUpgradeModulePlan -DirectoryPath 'C:\Scripts3' -FromAzureRmVersion '6.13.1' -ToAzVersion '5.6.0' -AzureRmModuleSpec $armSpec -AzModuleSpec $azSpec -AzAliasMappingSpec $azAliases
     #>
     [CmdletBinding()]
     Param
@@ -103,7 +103,7 @@ function New-AzUpgradeModulePlan
             Mandatory=$true,
             HelpMessage='Specify the Az module version to upgrade to.')]
         [System.String]
-        [ValidateSet('5.5.0')]
+        [ValidateSet('5.6.0')]
         $ToAzVersion,
 
         [Parameter(Mandatory=$false)]