Skip to content

Commit bd4cb0a

Browse files
committed
update help files
1 parent 05fe7c2 commit bd4cb0a

File tree

3 files changed

+94
-8
lines changed

3 files changed

+94
-8
lines changed

src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmDefault.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Clears the defaults set by the user in the current context.
1313
## SYNTAX
1414

1515
```
16-
Clear-AzureRmDefault [-ResourceGroup] [-WhatIf] [-Confirm]
16+
Clear-AzureRmDefault [-ResourceGroup] [-PassThru] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
17+
[-Confirm] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -38,6 +39,47 @@ This command removes the default resource group set by the user in the current c
3839

3940
## PARAMETERS
4041

42+
### -DefaultProfile
43+
The credentials, account, tenant, and subscription used for communication with azure.```yaml
44+
Type: IAzureContextContainer
45+
Parameter Sets: (All)
46+
Aliases: AzureRmContext, AzureCredential
47+
48+
Required: False
49+
Position: Named
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -Force
56+
Remove all defaults if no default is specified```yaml
57+
Type: SwitchParameter
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -PassThru
69+
{{Fill PassThru Description}}
70+
71+
```yaml
72+
Type: SwitchParameter
73+
Parameter Sets: (All)
74+
Aliases:
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
4183
### -ResourceGroup
4284
Clear Default Resource Group
4385
@@ -84,11 +126,13 @@ Accept pipeline input: False
84126
Accept wildcard characters: False
85127
```
86128
129+
### 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).
131+
87132
## INPUTS
88133
89134
### System.Management.Automation.SwitchParameter
90135
91-
92136
## OUTPUTS
93137
94138
### System.Object

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

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Get the defaults set by the user in the current context.
1313
## SYNTAX
1414

1515
```
16-
Get-AzureRmDefault [-ResourceGroup]
16+
Get-AzureRmDefault [-ResourceGroup] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -52,6 +52,19 @@ This command returns the current default Resource Group if there is a default se
5252

5353
## PARAMETERS
5454

55+
### -DefaultProfile
56+
The credentials, account, tenant, and subscription used for communication with azure.```yaml
57+
Type: IAzureContextContainer
58+
Parameter Sets: (All)
59+
Aliases: AzureRmContext, AzureCredential
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
5568
### -ResourceGroup
5669
Display Default Resource Group
5770
@@ -67,16 +80,17 @@ Accept pipeline input: True (ByPropertyName)
6780
Accept wildcard characters: False
6881
```
6982

83+
### CommonParameters
84+
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).
85+
7086
## INPUTS
7187

7288
### System.Management.Automation.SwitchParameter
7389

74-
7590
## OUTPUTS
7691

7792
### Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroup
7893

79-
8094
## NOTES
8195

8296
## RELATED LINKS

src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmDefault.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Sets a default in the current context
1313
## SYNTAX
1414

1515
```
16-
Set-AzureRmDefault [-ResourceGroupName <String>] [-WhatIf] [-Confirm]
16+
Set-AzureRmDefault [-ResourceGroupName <String>] [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
17+
[-Confirm] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -37,6 +38,32 @@ This command sets the default resource group to the resource group specified by
3738

3839
## PARAMETERS
3940

41+
### -DefaultProfile
42+
The credentials, account, tenant, and subscription used for communication with azure.```yaml
43+
Type: IAzureContextContainer
44+
Parameter Sets: (All)
45+
Aliases: AzureRmContext, AzureCredential
46+
47+
Required: False
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Force
55+
Create a new resource group if specified default does not exist```yaml
56+
Type: SwitchParameter
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
4067
### -ResourceGroupName
4168
Name of the resource group being set as default
4269

@@ -83,16 +110,17 @@ Accept pipeline input: False
83110
Accept wildcard characters: False
84111
```
85112
113+
### CommonParameters
114+
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).
115+
86116
## INPUTS
87117
88118
### System.String
89119
90-
91120
## OUTPUTS
92121
93122
### Microsoft.Azure.Management.Internal.Resources.Models.ResourceGroup
94123
95-
96124
## NOTES
97125
98126
## RELATED LINKS

0 commit comments

Comments
 (0)