Get-AzContainerRegistry cmdlet throws error when $PSModuleAutoLoadingPreference is set to None

[pewill]

Description

I want to explicitly load the modules I use and have disabled autoloading by setting $PSModuleAutoloadingPreference='None' in my profile. Most Az cmdlets works as expected but Az.ContainerRegistry doesn't play well with this approach.
When I run Get-AzContainerRegistry cmdlet it fails with error

ParentContainsErrorRecordException: <path to OneDrive>\Documents\PowerShell\Modules\Az.ContainerRegistry\4.3.0\ContainerRegistry.Autorest\exports\ProxyCmdletDefinitions.ps1:7226:9
Line |
7226 |          $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvoc …
     |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Exception calling "GetSteppablePipeline" with "1" argument(s): "The expression after '&' in a pipeline element produced an object that was not valid. It must result in a
     | command name, a script block, or a CommandInfo object."

Issue script & Debug output

# Easiest way to reproduce is to disable module autoloading in an existing session
# Assume Connect-AzAccount has been run
pwsh -NoProfile
Import-Module Az.ContainerRegistry
Get-AzContainerRegistry # works
$PSModuleAutoloadingPreference='None' 
Get-AzContainerRegistry # fails

Environment data

PSVersion                      7.4.6
PSEdition                      Core
GitCommitId                    7.4.6
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Module versions

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     4.0.2                 Az.Accounts                         {Add-AzEnvironment, Clear-AzConfig, Clear-AzContext, Clear-AzDefault…}
Script     4.3.0                 Az.ContainerRegistry                {Connect-AzContainerRegistry, Get-AzContainerRegistryManifest, Get-AzContainerRegistryRepository, Get-AzContainerRegistryTag…}

Error output

Message        : Exception calling "GetSteppablePipeline" with "1" argument(s): "The expression after '&' in a pipeline element produced an object that was not valid. It must re
                 sult in a command name, a script block, or a CommandInfo object."
StackTrace     :    at System.Management.Automation.Runspaces.PipelineBase.Invoke(IEnumerable input)
                    at Microsoft.PowerShell.Executor.ExecuteCommandHelper(Pipeline tempPipeline, Exception& exceptionThrown, ExecutionOptions options)
Exception      : System.Management.Automation.MethodInvocationException
InvocationInfo : {}
Line           :         $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin)

Position       : At <path to OneDrive>\Documents\PowerShell\Modules\Az.ContainerRegistry\4.3.0\ContainerRegistry.Autorest\exports\ProxyCmdletDefinitions.ps1:7226 char:9
                 +         $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvoc …
                 +         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
HistoryId      : 4

[isra-fel]

Hi, does "path to onedrive" contain special char? Such as quotes? If yes, could you try installing the modules in a local directory?
Also, could you try enabling auto loading and run Az.ContainerRegistry cmdlets again? Want to check if they are related.
Thanks!

[pewill]

The path does not contain any special characters. I tested on two machines, one with a path containing a space and the other where no spaces are included in the path.
Toggling the $PSModuleAutoloadingPreference back to All makes it work again.

pwsh -NoProfile
Import-Module Az.ContainerRegistry
Get-AzContainerRegistry # works
$PSModuleAutoloadingPreference='None' 
Get-AzContainerRegistry # fails
$PSModuleAutoloadingPreference='All' 
Get-AzContainerRegistry # works again

Other cmdlets, like Get-AzContainerGroup from Az.ContainerInstance does not have this issue despite a similar implementation with a proxy cmdlet.

pwsh -NoProfile
Import-Module Az.ContainerInstance
Get-AzContainerGroup # works
$PSModuleAutoloadingPreference='None' 
Get-AzContainerGroup # Still works

The issue seems to be in the ProxyCmdletDefinitions.ps1 where the command is resolved using $cmdInfo = Get-Command -Name $mapping[$parameterSet]. When autoloading is disabled it will return $null instead of the name Get-AzContainerRegistry

azure-powershell/src/ContainerRegistry/ContainerRegistry.Autorest/exports/ProxyCmdletDefinitions.ps1

Line 7218 in bd6445f

$cmdInfo = Get-Command -Name $mapping[$parameterSet]

[isra-fel]

Thanks for the research. It sure seems $PSModuleAutoLoadingPreference impacts whether Get-Command auto loads the module, as well as if it can return something. But this design of finding the correct parameter set is quite fundamental in the business logic that I'm not sure if we are able to change. @dolauli are there any alternative solutions that don't involve Get-Command?

Ref: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-command?view=powershell-7.4#:~:text=Get%2DCommand%20that%20uses%20the%20exact%20name%20of%20the%20command

[dolauli]

The issue happens in

azure-powershell/src/ContainerRegistry/ContainerRegistry.Autorest/exports/ProxyCmdletDefinitions.ps1

Line 7224 in bd6445f

$wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet)

The weird thing here it works with $PSModuleAutoloadingPreference='All' , which seems like a bug of GetCommand (https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.commandinvocationintrinsics.getcommand?view=powershellsdk-7.4.0#system-management-automation-commandinvocationintrinsics-getcommand(system-string-system-management-automation-commandtypes)).

We should try to getcommand for both [System.Management.Automation.CommandTypes]::Function and [System.Management.Automation.CommandTypes]::Cmdlet

[Pan-Qi]

autorest-powershell fix PR