Skip to content

Commit 98c1faf

Browse files
committed
addressing PR comments
- fixed bad formatting caused by bug in platyPS - Updated help documentation
1 parent ed0301c commit 98c1faf

27 files changed

+64
-32
lines changed

src/ResourceManager/Sql/ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Added Location Completer to -Location parameters allowing tab completion through valid Locations
2222
* Added ResourceGroup Completer to -ResourceGroup parameters allowing tab completion through resource groups in current subscription
2323
* Added -AsJob parameter to long running cmdlets
24-
* removed -DatabaseName parameter from Get-AzureRmSqlServiceObjective
24+
* Obsoleted -DatabaseName parameter from Get-AzureRmSqlServiceObjective
2525

2626
## Version 4.1.1
2727
* Added ability to rename database using Set-AzureRmSqlDatabase

src/ResourceManager/Sql/Commands.Sql/ServiceObjective/Cmdlet/AzureSqlServerServiceObjectiveCmdletBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public abstract class AzureSqlServerServiceObjectiveCmdletBase
4747
HelpMessage = "SQL Database name.",
4848
DontShow = true)]
4949
[ValidateNotNullOrEmpty]
50-
[Obsolete("This parameter is not needed or used. It will be removed in a future release.")]
50+
[Obsolete("This parameter is not needed or used. It will be removed in the next breaking change release.")]
5151
public string DatabaseName { get; set; }
5252

5353
/// <summary>

src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ CreationDate : 1/1/2017 12:00:00 AM
4141
## PARAMETERS
4242

4343
### -AsJob
44-
Run cmdlet in the background```yaml
44+
Run cmdlet in the background
45+
```yaml
4546
Type: SwitchParameter
4647
Parameter Sets: (All)
4748
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Gets service objectives for an Azure SQL Database server.
1515

1616
```
1717
Get-AzureRmSqlServerServiceObjective [[-ServiceObjectiveName] <String>] [-ServerName] <String>
18-
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19-
[<CommonParameters>]
18+
[[-DatabaseName] <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
@@ -49,6 +49,20 @@ This command gets the service objectives for the server named Server01 and the d
4949

5050
## PARAMETERS
5151

52+
### -DatabaseName
53+
SQL Database name.
54+
```yaml
55+
Type: String
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: 2
61+
Default value: None
62+
Accept pipeline input: True (ByPropertyName)
63+
Accept wildcard characters: False
64+
```
65+
5266
### -DefaultProfile
5367
The credentials, account, tenant, and subscription used for communication with azure
5468

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ This command creates a database named Database01 in the elastic pool named Elast
8181
## PARAMETERS
8282

8383
### -AsJob
84-
Run cmdlet in the background```yaml
84+
Run cmdlet in the background
85+
```yaml
8586
Type: SwitchParameter
8687
Parameter Sets: (All)
8788
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ This cmdlet is also supported by the SQL Server Stretch Database service on Azur
3939
## PARAMETERS
4040

4141
### -AsJob
42-
Run cmdlet in the background```yaml
42+
Run cmdlet in the background
43+
```yaml
4344
Type: SwitchParameter
4445
Parameter Sets: (All)
4546
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Accept wildcard characters: False
5757
```
5858
5959
### -AsJob
60-
Run cmdlet in the background```yaml
60+
Run cmdlet in the background
61+
```yaml
6162
Type: SwitchParameter
6263
Parameter Sets: (All)
6364
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ in. The command specifies DTU property values for the pool and the databases in
5252
## PARAMETERS
5353

5454
### -AsJob
55-
Run cmdlet in the background```yaml
55+
Run cmdlet in the background
56+
```yaml
5657
Type: SwitchParameter
5758
Parameter Sets: (All)
5859
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ This command creates a version 12 Azure SQL Database server.
4141
## PARAMETERS
4242

4343
### -AsJob
44-
Run cmdlet in the background```yaml
44+
Run cmdlet in the background
45+
```yaml
4546
Type: SwitchParameter
4647
Parameter Sets: (All)
4748
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ This command creates a link named Link01 between ContosoServer17 and ContosoServ
3737
## PARAMETERS
3838

3939
### -AsJob
40-
Run cmdlet in the background```yaml
40+
Run cmdlet in the background
41+
```yaml
4142
Type: SwitchParameter
4243
Parameter Sets: (All)
4344
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ The **New-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet creates a SQL d
3333
## PARAMETERS
3434

3535
### -AsJob
36-
Run cmdlet in the background```yaml
36+
Run cmdlet in the background
37+
```yaml
3738
Type: SwitchParameter
3839
Parameter Sets: (All)
3940
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDnsAlias.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ This command creates Azure SQL Server DNS Alias with the name aliasName that is
3636
## PARAMETERS
3737

3838
### -AsJob
39-
Run cmdlet in the background```yaml
39+
Run cmdlet in the background
40+
```yaml
4041
Type: SwitchParameter
4142
Parameter Sets: (All)
4243
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Creates an Azure SQL Server virtual network rule
3333
## PARAMETERS
3434

3535
### -AsJob
36-
Run cmdlet in the background```yaml
36+
Run cmdlet in the background
37+
```yaml
3738
Type: SwitchParameter
3839
Parameter Sets: (All)
3940
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDnsAlias.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ Removes Azure SQL Server DNS Alias with the name aliasName from the server with
4545
## PARAMETERS
4646

4747
### -AsJob
48-
Run cmdlet in the background```yaml
48+
Run cmdlet in the background
49+
```yaml
4950
Type: SwitchParameter
5051
Parameter Sets: (All)
5152
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ CreationDate : 1/1/2017 12:00:00 AM
4747
## PARAMETERS
4848

4949
### -AsJob
50-
Run cmdlet in the background```yaml
50+
Run cmdlet in the background
51+
```yaml
5152
Type: SwitchParameter
5253
Parameter Sets: (All)
5354
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Deletes an existing Azure SQL Server virtual network rule
3333
## PARAMETERS
3434

3535
### -AsJob
36-
Run cmdlet in the background```yaml
36+
Run cmdlet in the background
37+
```yaml
3738
Type: SwitchParameter
3839
Parameter Sets: (All)
3940
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ The second command restores the backup in $GeoBackup to the SQL database named R
104104
## PARAMETERS
105105

106106
### -AsJob
107-
Run cmdlet in the background```yaml
107+
Run cmdlet in the background
108+
```yaml
108109
Type: SwitchParameter
109110
Parameter Sets: (All)
110111
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ This command resumes a suspended Azure SQL Data Warehouse database.
3333
## PARAMETERS
3434

3535
### -AsJob
36-
Run cmdlet in the background```yaml
36+
Run cmdlet in the background
37+
```yaml
3738
Type: SwitchParameter
3839
Parameter Sets: (All)
3940
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ This command adds a database named Database01 to the elastic pool named ElasticP
8888
## PARAMETERS
8989

9090
### -AsJob
91-
Run cmdlet in the background```yaml
91+
Run cmdlet in the background
92+
```yaml
9293
Type: SwitchParameter
9394
Parameter Sets: (All)
9495
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ Accept wildcard characters: False
5959
```
6060
6161
### -AsJob
62-
Run cmdlet in the background```yaml
62+
Run cmdlet in the background
63+
```yaml
6364
Type: SwitchParameter
6465
Parameter Sets: (All)
6566
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@ storage for an elastic pool to 2 TB.
7272
## PARAMETERS
7373

7474
### -AsJob
75-
Run cmdlet in the background```yaml
75+
Run cmdlet in the background
76+
```yaml
7677
Type: SwitchParameter
7778
Parameter Sets: (All)
7879
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDnsAlias.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ This command is updating alias which was previously pointing to oldServer to poi
3535
## PARAMETERS
3636

3737
### -AsJob
38-
Run cmdlet in the background```yaml
38+
Run cmdlet in the background
39+
```yaml
3940
Type: SwitchParameter
4041
Parameter Sets: (All)
4142
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_012345678901
4949
## PARAMETERS
5050

5151
### -AsJob
52-
Run cmdlet in the background```yaml
52+
Run cmdlet in the background
53+
```yaml
5354
Type: SwitchParameter
5455
Parameter Sets: (All)
5556
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Modifies an existing virtual network rule with the new virtual network subnet id
3636
## PARAMETERS
3737

3838
### -AsJob
39-
Run cmdlet in the background```yaml
39+
Run cmdlet in the background
40+
```yaml
4041
Type: SwitchParameter
4142
Parameter Sets: (All)
4243
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ This command suspends an active Azure SQL Data Warehouse database.
3333
## PARAMETERS
3434

3535
### -AsJob
36-
Run cmdlet in the background```yaml
36+
Run cmdlet in the background
37+
```yaml
3738
Type: SwitchParameter
3839
Parameter Sets: (All)
3940
Aliases:

src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Accept wildcard characters: False
5757
```
5858
5959
### -AsJob
60-
Run cmdlet in the background```yaml
60+
Run cmdlet in the background
61+
```yaml
6162
Type: SwitchParameter
6263
Parameter Sets: (All)
6364
Aliases:

src/ResourceManager/Sql/documentation/current-breaking-changes.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,6 @@
4040

4141
## Current Breaking Changes
4242

43-
The following cmdlets were affected this release:
44-
45-
**Get-AzureRmSqlServiceObjective**
46-
- Database name parameter was removed. It was not needed or used.
47-
4843
**New-AzureRmSqlDatabaseFailoverGroup**
4944
- Tag parameter was removed
5045
- 'GracePeriodWithDataLossHour' parameter was renamed to 'GracePeriodWithDataLossHours'

0 commit comments

Comments
 (0)