[Az.Tools.Installer]: Updates for a new minor/patch version (#20022)

matsest · msJinLei · msJinLei · web-flow · commit 8872dfc1d99c · 2022-11-17T11:02:40.000+08:00
* fix: set repository to mandatory fix #19839 * chore: formatting * docs: update help * fix: update assembly to 2.21 * chore: add ChangeLog * fix: use shouldsupportprocess as its called by internal command * Update tools/Az.Tools.Installer/ChangeLog.md Co-authored-by: Mats Estensen <mats.est@gmail.com> * Microsoft.ApplicationInsights to 2.13.1 Revert the change of parameter `Repository` * Remove Az.Tools.Installer-help.xml * Fix typo in Update-AzModule help message Co-authored-by: Jin Lei <54836179+msJinLei@users.noreply.github.com> Co-authored-by: msJinLei <lei.jin@microsoft.com>
diff --git a/tools/Az.Tools.Installer/Az.Tools.Installer.psd1 b/tools/Az.Tools.Installer/Az.Tools.Installer.psd1
@@ -55,7 +55,7 @@
     
     # Assemblies that must be loaded prior to importing this module
     RequiredAssemblies = @(
-        '.\assembly\Microsoft.ApplicationInsights.2.12.0\Microsoft.ApplicationInsights.dll'
+        '.\assembly\Microsoft.ApplicationInsights.2.13.1\Microsoft.ApplicationInsights.dll'
     )
     
     # Script files (.ps1) that are run in the caller's environment prior to importing this module.
diff --git a/tools/Az.Tools.Installer/ChangeLog.md b/tools/Az.Tools.Installer/ChangeLog.md
@@ -0,0 +1,9 @@
+## Upcoming Release
+* Updated telemetry assembly to 2.13.1
+* Fixed typo in Az.Tools.Installer
+
+## 0.2.0
+* Az.Tools.Installer version 2 (#16321)
+
+## 0.1.0
+* Initial release
diff --git a/tools/Az.Tools.Installer/GenerateHelp.ps1 b/tools/Az.Tools.Installer/GenerateHelp.ps1
@@ -8,7 +8,7 @@ Param(
 )
 
 $ModuleFolder = Join-Path -Path $ArtifactFolder -ChildPath $ModuleName
-$TempDocFolder = Join-Path -Path $ArtifactFolder -ChildPath $ModuleName'.Doc'
+$TempDocFolder = Join-Path -Path $ModuleFolder -ChildPath 'help'
 Import-Module $ModuleFolder
-New-MarkdownHelp -Module $ModuleName -OutputFolder $TempDocFolder
-New-ExternalHelp –Path $TempDocFolder -OutputPath $ModuleFolder
+New-MarkdownHelp -Module $ModuleName -OutputFolder $TempDocFolder -Force
+New-ExternalHelp –Path $TempDocFolder -OutputPath $ModuleFolder -Force
diff --git a/tools/Az.Tools.Installer/assembly/Microsoft.ApplicationInsights.2.12.0/Microsoft.ApplicationInsights.dll b/tools/Az.Tools.Installer/assembly/Microsoft.ApplicationInsights.2.12.0/Microsoft.ApplicationInsights.dll
diff --git a/tools/Az.Tools.Installer/assembly/Microsoft.ApplicationInsights.2.13.1/Microsoft.ApplicationInsights.dll b/tools/Az.Tools.Installer/assembly/Microsoft.ApplicationInsights.2.13.1/Microsoft.ApplicationInsights.dll
diff --git a/tools/Az.Tools.Installer/exports/Install-AzModule.ps1 b/tools/Az.Tools.Installer/exports/Install-AzModule.ps1
@@ -41,7 +41,7 @@ function Install-AzModule {
         [string]
         ${RequiredAzVersion},
 
-        [Parameter(ParameterSetName = 'Default', HelpMessage = 'The Registered Repostory.')]
+        [Parameter(ParameterSetName = 'Default', HelpMessage = 'The Registered Repository to install module from. If only one repository is registered in PowerShell, Install-AzModule will use it. If more than one, please specify the Repository.')]
         [ValidateNotNullOrEmpty()]
         [string]
         ${Repository},
diff --git a/tools/Az.Tools.Installer/exports/Uninstall-AzModule.ps1 b/tools/Az.Tools.Installer/exports/Uninstall-AzModule.ps1
@@ -36,7 +36,7 @@ function Uninstall-AzModule {
         [string[]]
         ${Name},
 
-        [Parameter(ParameterSetName = 'Default',HelpMessage = 'Az modules to exclude from uninstallation.', ValueFromPipelineByPropertyName = $true)]
+        [Parameter(ParameterSetName = 'Default', HelpMessage = 'Az modules to exclude from uninstallation.', ValueFromPipelineByPropertyName = $true)]
         [ValidateNotNullOrEmpty()]
         [string[]]
         ${ExcludeModule},
diff --git a/tools/Az.Tools.Installer/exports/Update-AzModule.ps1 b/tools/Az.Tools.Installer/exports/Update-AzModule.ps1
@@ -32,7 +32,7 @@ function Update-AzModule {
         [string[]]
         ${Name},
 
-        [Parameter(HelpMessage = 'The Registered Repostory.')]
+        [Parameter(HelpMessage = 'The Registered Repository to install module from. If only one repository is registered in PowerShell, Update-AzModule will use it. If more than one, please specify the Repository.')]
         [ValidateNotNullOrEmpty()]
         [string]
         ${Repository},
diff --git a/tools/Az.Tools.Installer/help/Install-AzModule.md b/tools/Az.Tools.Installer/help/Install-AzModule.md
@@ -80,7 +80,9 @@ Accept wildcard characters: False
 ```
 
 ### -Repository
-The Registered Repostory.
+The Registered Repository to install module from.
+If only one repository is registered in PowerShell, Install-AzModule will use it.
+If more than one, please specify the Repository.
 
 ```yaml
 Type: String
diff --git a/tools/Az.Tools.Installer/help/Update-AzModule.md b/tools/Az.Tools.Installer/help/Update-AzModule.md
@@ -52,7 +52,9 @@ Accept wildcard characters: False
 ```
 
 ### -Repository
-The Registered Repostory.
+The Registered Repository to install module from.
+If only one repository is registered in PowerShell, Update-AzModule will use it.
+If more than one, please specify the Repository.
 
 ```yaml
 Type: String
diff --git a/tools/Az.Tools.Installer/internal/Add-RepositoryArgumentCompleter.ps1 b/tools/Az.Tools.Installer/internal/Add-RepositoryArgumentCompleter.ps1
@@ -17,7 +17,7 @@ function Add-RepositoryArgumentCompleter()
     param(
         [Parameter(Mandatory=$true)]
         [string[]]$cmdlets,
-        
+
         [Parameter(Mandatory=$true)]
         [string]$parameterName
     )
@@ -27,17 +27,17 @@ function Add-RepositoryArgumentCompleter()
         if(Get-Command -Name Register-ArgumentCompleter -ErrorAction SilentlyContinue)
         {
             Register-ArgumentCompleter -CommandName $cmdlets -ParameterName $parameterName -ScriptBlock {
-                param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter) 
-                
-                Get-PSRepository -Name "$wordTocomplete*"-ErrorAction SilentlyContinue -WarningAction SilentlyContinue | Foreach-Object { 
-                    [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name) 
-                } 
-           }
+                param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+
+                Get-PSRepository -Name "$wordTocomplete*"-ErrorAction SilentlyContinue -WarningAction SilentlyContinue | Foreach-Object {
+                    [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)
+                }
+            }
         }
     }
-    catch 
+    catch
     {
-        # All this functionality is optional, so suppress errors 
-        Write-Debug -Message "Error registering argument completer: $_"      
+        # All this functionality is optional, so suppress errors
+        Write-Debug -Message "Error registering argument completer: $_"
     }
 }
diff --git a/tools/Az.Tools.Installer/internal/Install-AzModuleInternal.ps1 b/tools/Az.Tools.Installer/internal/Install-AzModuleInternal.ps1
@@ -207,7 +207,6 @@ function Install-AzModuleInternal {
                                 $result = Install-SingleModule -ModuleName $tmodule.Name -ModuleVersion $tmodule.Version -InstallModuleParam $tInstallModuleParam -RemovePrevious:($using:confirmUninstallation)
                                 Write-Output $result
                             } -ThrottleLimit $maxJobCount
-                             #-StreamingHost $Host
                         }
                     }
                     else {
diff --git a/tools/Az.Tools.Installer/internal/Install-AzModule_ByPath.ps1 b/tools/Az.Tools.Installer/internal/Install-AzModule_ByPath.ps1
@@ -81,7 +81,7 @@ function Install-AzModule_ByPath {
                     Scope = if ($Scope) {$Scope} else {'CurrentUser'}
                     RemovePrevious = $RemovePrevious
                     Force = $Force
-                    Invoker = $Invoker             
+                    Invoker = $Invoker
                 }
                 Install-SingleModuleFromPackage @installModuleParams
             }
diff --git a/tools/Az.Tools.Installer/internal/Install-AzModule_Default.ps1 b/tools/Az.Tools.Installer/internal/Install-AzModule_Default.ps1
@@ -17,7 +17,6 @@ function Install-AzModule_Default {
     [CmdletBinding(PositionalBinding = $false, SupportsShouldProcess)]
     param(
         [Parameter(ValueFromPipelineByPropertyName = $true, Position = 0)]
-        #[ValidateNotNullOrEmpty()]
         [string[]]
         ${Name},
 
diff --git a/tools/Az.Tools.Installer/internal/Install-SingleModuleFromPackage.ps1 b/tools/Az.Tools.Installer/internal/Install-SingleModuleFromPackage.ps1
@@ -45,7 +45,7 @@ function Install-SingleModuleFromPackage{
 
     process {
         $InstallStarted = Get-Date
-        $downloader = [ParallelDownloader]::new()                
+        $downloader = [ParallelDownloader]::new()
         try {
             $filePath = $downloader.Download($Path, $DestinationPath)
             $moduleName = $downloader.LastModuleName
@@ -86,14 +86,14 @@ function Install-SingleModuleFromPackage{
             }
             PowerShellGet\Install-Module @installModuleParams -Name $moduleName -RequiredVersion "$moduleVersion"
         }
-        
+
         if (!$WhatIfPreference) {
             $moduleInstalled = @()
             $moduleInstalled += [PSCustomObject]@{
                 Name = $moduleName
                 Version = $moduleVersion
             }
-            Write-Output $moduleInstalled 
+            Write-Output $moduleInstalled
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`
`56`	`56`	`# Assemblies that must be loaded prior to importing this module`
`57`	`57`	`RequiredAssemblies = @(`
`58`		`- '.\assembly\Microsoft.ApplicationInsights.2.12.0\Microsoft.ApplicationInsights.dll'`
	`58`	`+ '.\assembly\Microsoft.ApplicationInsights.2.13.1\Microsoft.ApplicationInsights.dll'`
`59`	`59`	`)`
`60`	`60`
`61`	`61`	`# Script files (.ps1) that are run in the caller's environment prior to importing this module.`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ function Add-RepositoryArgumentCompleter()`
`17`	`17`	`param(`
`18`	`18`	`[Parameter(Mandatory=$true)]`
`19`	`19`	`[string[]]$cmdlets,`
`20`		`-`
	`20`	`+`
`21`	`21`	`[Parameter(Mandatory=$true)]`
`22`	`22`	`[string]$parameterName`
`23`	`23`	`)`
`@@ -27,17 +27,17 @@ function Add-RepositoryArgumentCompleter()`
`27`	`27`	`if(Get-Command -Name Register-ArgumentCompleter -ErrorAction SilentlyContinue)`
`28`	`28`	`{`
`29`	`29`	`Register-ArgumentCompleter -CommandName $cmdlets -ParameterName $parameterName -ScriptBlock {`
`30`		`- param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)`
`31`		`-`
`32`		`- Get-PSRepository -Name "$wordTocomplete*"-ErrorAction SilentlyContinue -WarningAction SilentlyContinue \| Foreach-Object {`
`33`		`- [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)`
`34`		`- }`
`35`		`- }`
	`30`	`+ param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)`
	`31`	`+`
	`32`	`+ Get-PSRepository -Name "$wordTocomplete*"-ErrorAction SilentlyContinue -WarningAction SilentlyContinue \| Foreach-Object {`
	`33`	`+ [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name)`
	`34`	`+ }`
	`35`	`+ }`
`36`	`36`	`}`
`37`	`37`	`}`
`38`		`- catch`
	`38`	`+ catch`
`39`	`39`	`{`
`40`		`- # All this functionality is optional, so suppress errors`
`41`		`- Write-Debug -Message "Error registering argument completer: $_"`
	`40`	`+ # All this functionality is optional, so suppress errors`
	`41`	`+ Write-Debug -Message "Error registering argument completer: $_"`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,6 @@ function Install-AzModuleInternal {`
`207`	`207`	`$result = Install-SingleModule -ModuleName $tmodule.Name -ModuleVersion $tmodule.Version -InstallModuleParam $tInstallModuleParam -RemovePrevious:($using:confirmUninstallation)`
`208`	`208`	`Write-Output $result`
`209`	`209`	`} -ThrottleLimit $maxJobCount`
`210`		`- #-StreamingHost $Host`
`211`	`210`	`}`
`212`	`211`	`}`
`213`	`212`	`else {`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ function Install-AzModule_ByPath {`
`81`	`81`	`Scope = if ($Scope) {$Scope} else {'CurrentUser'}`
`82`	`82`	`RemovePrevious = $RemovePrevious`
`83`	`83`	`Force = $Force`
`84`		`- Invoker = $Invoker`
	`84`	`+ Invoker = $Invoker`
`85`	`85`	`}`
`86`	`86`	`Install-SingleModuleFromPackage @installModuleParams`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ function Install-SingleModuleFromPackage{`
`45`	`45`
`46`	`46`	`process {`
`47`	`47`	`$InstallStarted = Get-Date`
`48`		`- $downloader = [ParallelDownloader]::new()`
	`48`	`+ $downloader = [ParallelDownloader]::new()`
`49`	`49`	`try {`
`50`	`50`	`$filePath = $downloader.Download($Path, $DestinationPath)`
`51`	`51`	`$moduleName = $downloader.LastModuleName`
`@@ -86,14 +86,14 @@ function Install-SingleModuleFromPackage{`
`86`	`86`	`}`
`87`	`87`	`PowerShellGet\Install-Module @installModuleParams -Name $moduleName -RequiredVersion "$moduleVersion"`
`88`	`88`	`}`
`89`		`-`
	`89`	`+`
`90`	`90`	`if (!$WhatIfPreference) {`
`91`	`91`	`$moduleInstalled = @()`
`92`	`92`	`$moduleInstalled += [PSCustomObject]@{`
`93`	`93`	`Name = $moduleName`
`94`	`94`	`Version = $moduleVersion`
`95`	`95`	`}`
`96`		`- Write-Output $moduleInstalled`
	`96`	`+ Write-Output $moduleInstalled`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`	`}`