AsJob is a common parameter for remotely loaded modules

[chrisda]

Unbeknownst to me, nearly every Exchange cmdlet has a parameter named AsJob. I understand the functionality of this parameter; I don't need an explanation of what it does.

I confirmed the availability of AsJob in the Exchange Management Shell, and New-MarkdownHelp dutifully detected it.

AsJob isn't mentioned in the Common Parameters (Debug, Verbose, ErrorAction, ErrorVariable, etc.) at https://go.microsoft.com/fwlink/p/?LinkID=113216. But I also confirmed that AsJob isn't present anywhere in the Exchange MAML XML files.

Should AsJob be treated like a Common Parameter? Is there a way to suppress AsJob from platyPS?

[vors]

Common parameters is a well-defined set of parameter names across all PowerShell. If a module has it's own common parameter platyPS doesn't currently have a mechanics to avoid copy-pasting it's name. That would be a useful thing to have since the situation is very common, no pun intended.

But I also confirmed that AsJob isn't present anywhere in the Exchange MAML XML files.

Can you attach one xml, I'd be curious to check how does it work.

[vors]

Could it be the case that AsJob is not present in one module flavour, similar to #338 (comment) ?

[BernieWhite]

I'd previously thought that it would be handy to have a markdown include feature, where -AsJob could be referenced from a separate file.

[chrisda]

OK. Here's a MAML XML file.

Microsoft.Exchange.ProvisioningAndMigration-Help.xml.zip

[BernieWhite]

Fairly sure this extra-AsJob parameter is related to PS remoting.

[vors]

@BernieWhite oh, nice catch!

[chrisda]

Groovy. But, the only way to interact with Exchange in PowerShell is through remoting. Even when you open the Exchange Management Shell on the local server, you're still remoting into the local server behind-the-scenes.

So, anything that can be done to selectively suppress AsJob would be very helpful.

[vors]

If we implement the #338 by running Get-Command in the remote module session context, that would solve this problem. Otherwise, we can filter it out, if we detect that module is remote.

[vors]

Found a documentation about AsJob being the common parameter: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/import-pssession?view=powershell-6

[vors]

Fixed in #361