[Az.Tools.Installer]: Updates for a new minor/patch version

[matsest]

Description

There hasn't been a release for Az.Tools.Installer for a long time (0.2.0) - even with changes being made to it several months ago - so adding a few updates to hopefully make it ready for a new release.

• Set Repository parameter to Mandatory for Install-AzModule and Update-AzModule (fixes [Feature]: Improve error message for Az.Tools.Installer #19839)
• Update telemetry assembly to latest stable version
• Formatting of PS files
• Generate and update markdown/help files
• Add changelog file for this module

Checklist

• Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

• SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
• SHOULD make the title of PR clear and informative, and in the present imperative tense.
• SHOULD update ChangeLog.md file(s) appropriately
  • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
  • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. Add changelog in description section if PR goes into generation branch.
  • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
• SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
  • Create new module from scratch
  • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
  • Create new resource type which name doesn't use module name as prefix
  • Have design question before implementation
• SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
• SHOULD have proper test coverage for changes in pull request.
• SHOULD NOT introduce breaking changes in Az minor release except preview version.
• SHOULD NOT adjust version of module manually in pull request

[ghost]

Thank you for your contribution matsest! We will review the pull request and get back to you soon.

[Nickcandy]

Changing parameters to mandatory would cause a breaking change which is not allowed in regular releases. Is that right? @BethanyZhou

[BethanyZhou]

Changing parameters to mandatory would cause a breaking change which is not allowed in regular releases. Is that right? @BethanyZhou

That's true for module with stable version. Az.Tools.Installer is under preview, its version is 0.2.0, That's fine to include breaking changes.

[msJinLei]

/azp list

[azure-pipelines]

CI/CD Pipelines for this repository:

• azure-powershell - powershell-core
• azure-powershell - windows-powershell
• azure-powershell - security-tools

[matsest]

Let me know if this should not be updated (I see that it failed some tests in ADO, but I can't see where the relevant test is specified)

[msJinLei]

Let me know if this should not be updated (I see that it failed some tests in ADO, but I can't see where the relevant test is specified)

Hi @matsest, Welcome to contribute to Az.Tools.Installer！

The pipeline fails of other reasons. We are fixing it.
However, we still cannot upgrade ApplicationInsights to the latest version for PowerShell 7.0+ cannot support it. I have change the version to 2.13.1.

I also revert the change of Repository for we keep the parameter as optional to be consistent with PowerShellGet. To clarify the ambiguity, I add more explanation in the help message.

I remove the Az.Tools.Installer-help.xml for we will generate it every time we release a new version.

Please review the change I've made.

[matsest]

@msJinLei Thanks for the updates on ApplicationInsights

I also revert the change of Repository for we keep the parameter as optional to be consistent with PowerShellGet. To clarify the ambiguity, I add more explanation in the help message.

With removal of the mandatory value the linked issue will however not be resolved as I see the behaviour when it's not given is:

$ Update-AzModule

Find-Module: Cannot validate argument on parameter 'Repository'. The argument is null, empty, or an element of the argument collection contains a
null value. Supply a collection that does not contain any null values and then try the command again.

PropertyNotFoundException: The property 'Version' cannot be found on this object. Verify that the property exists.

InvalidArgument: /home/matsest/personal/azure-powershell/tools/Az.Tools.Installer/exports/Update-AzModule.ps1:94
Line |
  94 |  … eUpdateTable = $modulesToUpdate | Foreach-Object { [PSCustomObject]@{
     |                                                       ~~~~~~~~~~~~~~~~~~
     | Cannot convert value "0" to type "System.Version". Error: "Version string portion was too short or too long. (Parameter 'input')"

If it's not desirable to be mandatory, should this error be catched?

If only one repository is registered in PowerShell, Install-AzModule will use it.

I can't see that this is the implemented behaviour? (see comment below)

[matsest]

For reference, I do only have one repository:

$ Get-PSRepository

Name                      InstallationPolicy   SourceLocation
----                      ------------------   --------------
PSGallery                 Trusted              https://www.powershellgallery.com/api/v2

[msJinLei]

@matsest Could you report the issue here https://github.com/Azure/azure-powershell/issues？ Thanks

[matsest]

@msJinLei I would assume the issue already listed in the description of this PR is covering this sufficiently - see #19839

Let me know if there should be created another one

[msJinLei]

OK. I will check it later.

[matsest]

@msJinLei I see this was merged but the issue regarding the Repository parameter was not resolved as I suggested. Https://github.com/Azure/azure-powershell/issues/19839 should be reopened..

[msJinLei]

@msJinLei I see this was merged but the issue regarding the Repository parameter was not resolved as I suggested. Https://github.com/Azure/azure-powershell/issues/19839 should be reopened..

@matsest I created an issue for it #20209 and will fix it soon. Thanks for reporting.

[Nickcandy]

/azp run azure-powershell - security-tools

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).