Skip to content

Remove invalid -all parameter from example in Get-AzureRmSubscription docs #4394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 2, 2017
Merged

Remove invalid -all parameter from example in Get-AzureRmSubscription docs #4394

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ba8736
removing invalid -all parameter
Aug 1, 2017
c23451a
reverting outputs section change
Aug 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml
online version:
online version:
schema: 2.0.0
---

Expand All @@ -22,20 +22,24 @@ Get-AzureRmSubscription [-SubscriptionName <String>] [-TenantId <String>] [<Comm
```

## DESCRIPTION
The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription name, and home tenant for subscriptions that the current account can access.

The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription
name, and home tenant for subscriptions that the current account can
access.

## EXAMPLES

### Example 1: Get all subscriptions in all tenants
```
PS C:\>Get-AzureRmSubscription -All
PS C:\>Get-AzureRmSubscription

Subscription Name : Contoso Subscription 1
SubscriptionId : xxxx-xxxx-xxxx-xxxx
TenantId : yyyy-yyyy-yyyy-yyyy
```

This command gets all subscriptions in all tenants that are authorized for the current account.
This command gets all subscriptions in all tenants that are authorized for
the current account.

### Example 2: Get all subscriptions for a specific tenant
```
Expand All @@ -50,7 +54,8 @@ SubscriptionId : yyyy-yyyy-yyyy-yyyy
TenantId : xxxx-xxxx-xxxx-xxxx
```

List all subscriptions in the given tenant that are authorized for the current account.
List all subscriptions in the given tenant that are authorized for the
current account.

### Example 3: Get all subscriptions in the current tenant
```
Expand All @@ -65,7 +70,8 @@ SubscriptionId : yyyy-yyyy-yyyy-yyyy
TenantId : xxxx-xxxx-xxxx-xxxx
```

This command gets all subscriptions in the current tenant that are authorized for the current user.
This command gets all subscriptions in the current tenant that are
authorized for the current user.

### Example 4: Change the current context to use a specific subscription
```
Expand All @@ -76,8 +82,9 @@ SubscriptionId : xxxx-xxxx-xxxx-xxxx
TenantId : yyyy-yyyy-yyyy-yyyy
```

This command gets the specified subscription, and then sets the current context to use it.
All subsequent cmdlets in this session use the new subscription (Contoso Subscription 1) by default.
This command gets the specified subscription, and then sets the current
context to use it. All subsequent cmdlets in this session use the new
subscription (Contoso Subscription 1) by default.

## PARAMETERS

Expand All @@ -87,7 +94,7 @@ Specifies the ID of the subscription to get.
```yaml
Type: String
Parameter Sets: ListByIdInTenant
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -102,7 +109,7 @@ Specifies the name of the subscription to get.
```yaml
Type: String
Parameter Sets: ListByNameInTenant
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -117,7 +124,7 @@ Specifies the ID of the tenant that contains subscriptions to get.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -127,7 +134,11 @@ Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction,
-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable,
-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and
-WarningVariable. For more information, see
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand All @@ -138,4 +149,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES

## RELATED LINKS