Fix returned fields in Get-AzureRmSubscription docs

[SteGriff]

Description

Fixed the examples of returned fields in Get-AzureRmSubscription. Added an extra piped statement to Example 4 because it would not naturally work with the newly renamed fields.

Fixes issue #4935

---

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

• I have read the contribution guidelines.
• If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
• If any large changes are made to a service, they are reflected in the respective change log.

General Guidelines

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
• The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

• Pull request includes test coverage for the included changes.
• PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

• New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
• Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

• Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
• Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
• Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

[msftclas]

All CLA requirements met.

[azuresdkci]

Can one of the admins verify this patch?

[SteGriff]

Hi @cormacpayne, how does this look?

[cormacpayne]

@SteGriff Hey Stephen, thanks for making this change! This is exactly what needed to be one ☺️ I just had one minor comment that needed clarification

[cormacpayne]

@SteGriff the Set-AzureRmContext cmdlet accepts a PSAzureSubscription object from the pipeline for the SubscriptionObject parameter. Any reason you want to change it to pass the SubscriptionId to Set-AzureRmContext instead? (this is just out of curiosity; I actually didn't know about the Select @{n=<name>;e=<expression>} trick ☺️ )

[SteGriff]

My experience of the command as written is that it doesn't work. Here's what happens for me, maybe you can verify?

# Outputs my context unchanged. The subscription is not switched, no error:
Get-AzureRmSubscription -SubscriptionId xxxx -TenantId yyyy | Set-AzureRmContext

# Capturing the object specifically and passing it as context throws error:
$ctx = Get-AzureRmSubscription -SubscriptionId xxxx -TenantId yyyy
Set-AzureRmContext -Context $ctx

Set-AzureRmContext : Cannot bind parameter 'Context'. Cannot convert the "8d6daea2-6038-4360-89a9-9944afa3ff6d" 
value of type "Microsoft.Azure.Commands.Profile.Models.PSAzureSubscription" to type 
"Microsoft.Azure.Commands.Profile.Models.PSAzureContext".
At line:1 char:29
+ Set-AzureRmContext -Context $ctx
+                             ~~~~
    + CategoryInfo          : InvalidArgument: (:) [Set-AzureRmContext], ParameterBindingException
    + FullyQualifiedErrorId : CannotConvertArgumentNoMessage,Microsoft.Azure.Commands.Profile.SetAzureRMContextCo 
   mmand

Maybe I'm being stupid but this pipe has never worked for me. I have also tried Select-AzureRmSubscription at the end and it behaves the same. That's why I've gotten the habit of extracting the SubscriptionId specifically.

Perhaps we're straying into the territory of another issue and I should just put the sample the way you have said?

[cormacpayne]

Ah, so Get-AzureRmSubscription doesn't return a PSAzureContext, it returns a PSAzureSubscription, so you'll need to use the SubscriptionObject parameter instead of the Context parameter:

$sub = Get-AzureRmSubscription -SubscriptionId xxxx -TenantId yyyy
Set-AzureRmContext -SubscriptionObject $sub

# Alternatively, you can use piping
Get-AzureRmSubscription -SubscriptionId xxxx -TenantId yyyy | Set-AzureRmContext

[markcowl]

Also, this works:

PS C:\Users\markcowl> Get-AzureRmSubscription | Set-AzureRmContext


Name             : [markcowl@microsoft.com, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx]
Account          : markcowl@microsoft.com
SubscriptionName : node
TenantId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
Environment      : AzureCloud

Name             : [markcowl@microsoft.com, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx]
Account          : markcowl@microsoft.com
SubscriptionName : Azure SDK CI
TenantId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
Environment      : AzureCloud

Name             : [markcowl@microsoft.com, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx]
Account          : markcowl@microsoft.com
SubscriptionName : Node CLI Test
TenantId         : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
Environment      : AzureCloud

[markcowl]

PowerShell is smart enough to accept pipeline input for a subscription or a context for this cmdlet

[cormacpayne]

@azuresdkci add to whitelist

[SteGriff]

@cormacpayne Thanks for the feedback! I think I have amended the PR correctly (my first time amending a PR on here) 😓

[cormacpayne]

@SteGriff no worries at all! We appreciate the fix ☺️ The changes in this PR look good to me, so I'll go ahead and merge it later today or tomorrow when we are finished with a release we're doing (need to make sure the release branch gets merged back into preview before merging anything into preview).