Skip to content

Commit 5672a17

Browse files
authored
Merge pull request #4394 from sdwheeler/sdw-Bug1050036
Remove invalid -all parameter from example in Get-AzureRmSubscription docs
2 parents 45a2f11 + c23451a commit 5672a17

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml
3-
online version:
3+
online version:
44
schema: 2.0.0
55
---
66

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

2424
## DESCRIPTION
25-
The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription name, and home tenant for subscriptions that the current account can access.
25+
26+
The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription
27+
name, and home tenant for subscriptions that the current account can
28+
access.
2629

2730
## EXAMPLES
2831

2932
### Example 1: Get all subscriptions in all tenants
3033
```
31-
PS C:\>Get-AzureRmSubscription -All
34+
PS C:\>Get-AzureRmSubscription
3235
3336
Subscription Name : Contoso Subscription 1
3437
SubscriptionId : xxxx-xxxx-xxxx-xxxx
3538
TenantId : yyyy-yyyy-yyyy-yyyy
3639
```
3740

38-
This command gets all subscriptions in all tenants that are authorized for the current account.
41+
This command gets all subscriptions in all tenants that are authorized for
42+
the current account.
3943

4044
### Example 2: Get all subscriptions for a specific tenant
4145
```
@@ -50,7 +54,8 @@ SubscriptionId : yyyy-yyyy-yyyy-yyyy
5054
TenantId : xxxx-xxxx-xxxx-xxxx
5155
```
5256

53-
List all subscriptions in the given tenant that are authorized for the current account.
57+
List all subscriptions in the given tenant that are authorized for the
58+
current account.
5459

5560
### Example 3: Get all subscriptions in the current tenant
5661
```
@@ -65,7 +70,8 @@ SubscriptionId : yyyy-yyyy-yyyy-yyyy
6570
TenantId : xxxx-xxxx-xxxx-xxxx
6671
```
6772

68-
This command gets all subscriptions in the current tenant that are authorized for the current user.
73+
This command gets all subscriptions in the current tenant that are
74+
authorized for the current user.
6975

7076
### Example 4: Change the current context to use a specific subscription
7177
```
@@ -76,8 +82,9 @@ SubscriptionId : xxxx-xxxx-xxxx-xxxx
7682
TenantId : yyyy-yyyy-yyyy-yyyy
7783
```
7884

79-
This command gets the specified subscription, and then sets the current context to use it.
80-
All subsequent cmdlets in this session use the new subscription (Contoso Subscription 1) by default.
85+
This command gets the specified subscription, and then sets the current
86+
context to use it. All subsequent cmdlets in this session use the new
87+
subscription (Contoso Subscription 1) by default.
8188

8289
## PARAMETERS
8390

@@ -87,7 +94,7 @@ Specifies the ID of the subscription to get.
8794
```yaml
8895
Type: String
8996
Parameter Sets: ListByIdInTenant
90-
Aliases:
97+
Aliases:
9198

9299
Required: False
93100
Position: Named
@@ -102,7 +109,7 @@ Specifies the name of the subscription to get.
102109
```yaml
103110
Type: String
104111
Parameter Sets: ListByNameInTenant
105-
Aliases:
112+
Aliases:
106113

107114
Required: False
108115
Position: Named
@@ -117,7 +124,7 @@ Specifies the ID of the tenant that contains subscriptions to get.
117124
```yaml
118125
Type: String
119126
Parameter Sets: (All)
120-
Aliases:
127+
Aliases:
121128

122129
Required: False
123130
Position: Named
@@ -127,7 +134,11 @@ Accept wildcard characters: False
127134
```
128135
129136
### CommonParameters
130-
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).
137+
This cmdlet supports the common parameters: -Debug, -ErrorAction,
138+
-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable,
139+
-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and
140+
-WarningVariable. For more information, see
141+
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
131142
132143
## INPUTS
133144
@@ -138,4 +149,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
138149
## NOTES
139150
140151
## RELATED LINKS
141-

0 commit comments

Comments
 (0)