Skip to content

Commit 8cd036c

Browse files
committed
Fix help files for Sql extension cmdlets
1 parent 95bd6b0 commit 8cd036c

File tree

3 files changed

+70
-34
lines changed

3 files changed

+70
-34
lines changed

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoBackupConfig.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ Creates a configuration object for SQL Server automatic backup.
1414

1515
### StorageUriSqlServerAutoBackup (Default)
1616
```
17-
New-AzureRmVMSqlServerAutoBackupConfig [-Enable] [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption]
18-
[[-CertificatePassword] <SecureString>] [[-StorageUri] <Uri>] [[-StorageKey] <SecureString>]
19-
[-BackupSystemDbs] [-BackupScheduleType <String>] [-FullBackupFrequency <String>]
20-
[-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>] [-LogBackupFrequencyInMinutes <Int32>]
21-
[-Profile <AzureSMProfile>] [<CommonParameters>]
17+
New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] [[-RetentionPeriodInDays] <Int32>]
18+
[-EnableEncryption] [[-CertificatePassword] <SecureString>] [[-StorageUri] <Uri>]
19+
[[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>]
20+
[-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>]
21+
[-LogBackupFrequencyInMinutes <Int32>] [<CommonParameters>]
2222
```
2323

2424
### StorageContextSqlServerAutoBackup
2525
```
26-
New-AzureRmVMSqlServerAutoBackupConfig [-Enable] [[-RetentionPeriodInDays] <Int32>] [-EnableEncryption]
27-
[[-CertificatePassword] <SecureString>] [[-StorageContext] <AzureStorageContext>] [[-StorageUri] <Uri>]
28-
[[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>]
26+
New-AzureRmVMSqlServerAutoBackupConfig [-ResourceGroupName] <String> [-Enable] [[-RetentionPeriodInDays] <Int32>]
27+
[-EnableEncryption] [[-CertificatePassword] <SecureString>] [[-StorageContext] <AzureStorageContext>]
28+
[[-StorageUri] <Uri>] [[-StorageKey] <SecureString>] [-BackupSystemDbs] [-BackupScheduleType <String>]
2929
[-FullBackupFrequency <String>] [-FullBackupStartHour <Int32>] [-FullBackupWindowInHours <Int32>]
30-
[-LogBackupFrequencyInMinutes <Int32>] [-Profile <AzureSMProfile>] [<CommonParameters>]
30+
[-LogBackupFrequencyInMinutes <Int32>] [<CommonParameters>]
3131
```
3232

3333
## DESCRIPTION
@@ -115,7 +115,7 @@ Parameter Sets: (All)
115115
Aliases:
116116

117117
Required: False
118-
Position: 3
118+
Position: 4
119119
Default value: None
120120
Accept pipeline input: False
121121
Accept wildcard characters: False
@@ -132,7 +132,7 @@ Parameter Sets: (All)
132132
Aliases:
133133

134134
Required: False
135-
Position: 0
135+
Position: 1
136136
Default value: None
137137
Accept pipeline input: True (ByPropertyName)
138138
Accept wildcard characters: False
@@ -147,7 +147,7 @@ Parameter Sets: (All)
147147
Aliases:
148148

149149
Required: False
150-
Position: 2
150+
Position: 3
151151
Default value: None
152152
Accept pipeline input: True (ByPropertyName)
153153
Accept wildcard characters: False
@@ -206,16 +206,18 @@ Accept pipeline input: True (ByPropertyName)
206206
Accept wildcard characters: False
207207
```
208208
209-
### -Profile
210-
In-memory profile.```yaml
211-
Type: AzureSMProfile
209+
### -ResourceGroupName
210+
Specifies the name of the resource group of the virtual machine.
211+
212+
```yaml
213+
Type: String
212214
Parameter Sets: (All)
213215
Aliases:
214216

215-
Required: False
216-
Position: Named
217+
Required: True
218+
Position: 0
217219
Default value: None
218-
Accept pipeline input: False
220+
Accept pipeline input: True (ByPropertyName)
219221
Accept wildcard characters: False
220222
```
221223
@@ -228,7 +230,7 @@ Parameter Sets: (All)
228230
Aliases:
229231

230232
Required: False
231-
Position: 1
233+
Position: 2
232234
Default value: None
233235
Accept pipeline input: True (ByPropertyName)
234236
Accept wildcard characters: False
@@ -245,7 +247,7 @@ Parameter Sets: StorageContextSqlServerAutoBackup
245247
Aliases:
246248

247249
Required: False
248-
Position: 4
250+
Position: 5
249251
Default value: None
250252
Accept pipeline input: True (ByPropertyName)
251253
Accept wildcard characters: False

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerAutoPatchingConfig.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ The acceptable values for this parameter are:
5858
Type: String
5959
Parameter Sets: (All)
6060
Aliases:
61+
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Everyday
6162

6263
Required: False
6364
Position: Named
@@ -123,6 +124,7 @@ Specifies whether important updates should be included.
123124
Type: String
124125
Parameter Sets: (All)
125126
Aliases:
127+
Accepted values: Important
126128

127129
Required: False
128130
Position: Named

src/ResourceManager/Compute/Commands.Compute/help/New-AzureRmVMSqlServerKeyVaultCredentialConfig.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Creates a configuration object for SQL server key vault credential on a virtual
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmVMSqlServerKeyVaultCredentialConfig [-Enable] [[-CredentialName] <String>]
17-
[[-AzureKeyVaultUrl] <String>] [[-ServicePrincipalName] <String>] [[-ServicePrincipalSecret] <SecureString>]
18-
[-Profile <AzureSMProfile>] [<CommonParameters>]
16+
New-AzureRmVMSqlServerKeyVaultCredentialConfig [-ResourceGroupName] <String> [-Enable] [-CredentialName <String>]
17+
[-AzureKeyVaultUrl <String>] [-ServicePrincipalName <String>] [-ServicePrincipalSecret <SecureString>]
18+
[-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -31,7 +31,7 @@ Parameter Sets: (All)
3131
Aliases:
3232

3333
Required: False
34-
Position: 0
34+
Position: Named
3535
Default value: None
3636
Accept pipeline input: True (ByPropertyName)
3737
Accept wildcard characters: False
@@ -44,7 +44,7 @@ Parameter Sets: (All)
4444
Aliases:
4545

4646
Required: False
47-
Position: 0
47+
Position: Named
4848
Default value: None
4949
Accept pipeline input: True (ByPropertyName)
5050
Accept wildcard characters: False
@@ -57,22 +57,22 @@ Parameter Sets: (All)
5757
Aliases:
5858

5959
Required: False
60-
Position: 0
60+
Position: Named
6161
Default value: None
6262
Accept pipeline input: True (ByPropertyName)
6363
Accept wildcard characters: False
6464
```
6565
66-
### -Profile
67-
In-memory profile.```yaml
68-
Type: AzureSMProfile
66+
### -ResourceGroupName
67+
```yaml
68+
Type: String
6969
Parameter Sets: (All)
7070
Aliases:
7171

72-
Required: False
73-
Position: Named
72+
Required: True
73+
Position: 0
7474
Default value: None
75-
Accept pipeline input: False
75+
Accept pipeline input: True (ByPropertyName)
7676
Accept wildcard characters: False
7777
```
7878
@@ -83,7 +83,7 @@ Parameter Sets: (All)
8383
Aliases:
8484

8585
Required: False
86-
Position: 0
86+
Position: Named
8787
Default value: None
8888
Accept pipeline input: True (ByPropertyName)
8989
Accept wildcard characters: False
@@ -96,12 +96,44 @@ Parameter Sets: (All)
9696
Aliases:
9797

9898
Required: False
99-
Position: 0
99+
Position: Named
100100
Default value: None
101101
Accept pipeline input: True (ByPropertyName)
102102
Accept wildcard characters: False
103103
```
104104
105+
### -Confirm
106+
Prompts you for confirmation before running the cmdlet.
107+
108+
```yaml
109+
Type: SwitchParameter
110+
Parameter Sets: (All)
111+
Aliases: cf
112+
113+
Required: False
114+
Position: Named
115+
Default value: False
116+
Accept pipeline input: False
117+
Accept wildcard characters: False
118+
```
119+
120+
### -WhatIf
121+
Shows what would happen if the cmdlet runs.
122+
123+
The cmdlet is not run.
124+
125+
```yaml
126+
Type: SwitchParameter
127+
Parameter Sets: (All)
128+
Aliases: wi
129+
130+
Required: False
131+
Position: Named
132+
Default value: False
133+
Accept pipeline input: False
134+
Accept wildcard characters: False
135+
```
136+
105137
### CommonParameters
106138
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).
107139

0 commit comments

Comments
 (0)