Skip to content

Commit 3d5af21

Browse files
committed
Updating markdown for cmdlets.
1 parent d6a8d74 commit 3d5af21

File tree

143 files changed

+1013
-746
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+1013
-746
lines changed

src/ResourceManager/Sql/ChangeLog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
## Current Release
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
23+
* Added -AsJob parameter to long running cmdlets
24+
* removed -DatabaseName parameter from Get-AzureRmSqlServiceObjective
2325

2426
## Version 4.1.1
2527
* Added ability to rename database using Set-AzureRmSqlDatabase

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ One or more Azure SQL Databases on the Failover Group's primary server to be add
5959
```yaml
6060
Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]
6161
Parameter Sets: (All)
62-
Aliases:
62+
Aliases:
6363

6464
Required: True
6565
Position: Named
@@ -89,7 +89,7 @@ The name of the Azure SQL Database Failover Group.
8989
```yaml
9090
Type: String
9191
Parameter Sets: (All)
92-
Aliases:
92+
Aliases:
9393

9494
Required: True
9595
Position: 2
@@ -104,7 +104,7 @@ The name of the resource group.
104104
```yaml
105105
Type: String
106106
Parameter Sets: (All)
107-
Aliases:
107+
Aliases:
108108

109109
Required: True
110110
Position: 0
@@ -119,7 +119,7 @@ The name of the primary Azure SQL Database Server of the Failover Group.
119119
```yaml
120120
Type: String
121121
Parameter Sets: (All)
122-
Aliases:
122+
Aliases:
123123

124124
Required: True
125125
Position: 1

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

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Adds a Key Vault key to a SQL server.
1313
## SYNTAX
1414

1515
```
16-
Add-AzureRmSqlServerKeyVaultKey [-KeyId] <String> [-ServerName] <String> [-ResourceGroupName] <String>
16+
Add-AzureRmSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String>
1717
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

@@ -23,7 +23,7 @@ The server must have 'get, wrapKey, unwrapKey' permissions to the vault.
2323

2424
## EXAMPLES
2525

26-
### -------------------------- Example 1: Add Key Vault key --------------------------
26+
### Example 1: Add Key Vault key
2727
```
2828
PS C:\> Add-AzureRmSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup'
2929
```
@@ -40,6 +40,19 @@ CreationDate : 1/1/2017 12:00:00 AM
4040

4141
## PARAMETERS
4242

43+
### -AsJob
44+
Run cmdlet in the background```yaml
45+
Type: SwitchParameter
46+
Parameter Sets: (All)
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
4356
### -DefaultProfile
4457
The credentials, account, tenant, and subscription used for communication with azure
4558
@@ -61,7 +74,7 @@ The Azure Key Vault KeyId.
6174
```yaml
6275
Type: String
6376
Parameter Sets: (All)
64-
Aliases:
77+
Aliases:
6578

6679
Required: True
6780
Position: 2
@@ -76,7 +89,7 @@ The name of the resource group
7689
```yaml
7790
Type: String
7891
Parameter Sets: (All)
79-
Aliases:
92+
Aliases:
8093

8194
Required: True
8295
Position: 0
@@ -91,7 +104,7 @@ The Azure Sql Server name.
91104
```yaml
92105
Type: String
93106
Parameter Sets: (All)
94-
Aliases:
107+
Aliases:
95108

96109
Required: True
97110
Position: 1

src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ Starts the upgrade of a SQL Database server.
402402
Starts a sync group synchronization.
403403

404404
### [Stop-AzureRmSqlDatabaseActivity](Stop-AzureRmSqlDatabaseActivity.md)
405-
Cancels the asynchronous updateslo operation on the database.
405+
Cancels the asynchronous updates operation on the database.
406406

407407
### [Stop-AzureRmSqlDatabaseExecuteIndexRecommendation](Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md)
408408
Stops the workflow that runs a recommended index operation.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Specifies the name of the database to get.
5050
```yaml
5151
Type: String
5252
Parameter Sets: (All)
53-
Aliases:
53+
Aliases:
5454

5555
Required: False
5656
Position: 2
@@ -80,7 +80,7 @@ Specifies the name of the resource group to which the SQL database server is ass
8080
```yaml
8181
Type: String
8282
Parameter Sets: (All)
83-
Aliases:
83+
Aliases:
8484

8585
Required: True
8686
Position: 0
@@ -95,7 +95,7 @@ Specifies the name of the server that hosts the backup to restore.
9595
```yaml
9696
Type: String
9797
Parameter Sets: (All)
98-
Aliases:
98+
Aliases:
9999

100100
Required: True
101101
Position: 1

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Specifies the name of the database.
4848
```yaml
4949
Type: String
5050
Parameter Sets: (All)
51-
Aliases:
51+
Aliases:
5252

5353
Required: False
5454
Position: 2
@@ -79,7 +79,7 @@ To get a **DateTime** object, use the Get-Date cmdlet.
7979
```yaml
8080
Type: DateTime
8181
Parameter Sets: (All)
82-
Aliases:
82+
Aliases:
8383

8484
Required: False
8585
Position: 3
@@ -94,7 +94,7 @@ Specifies the name of the resource group to which the server is assigned.
9494
```yaml
9595
Type: String
9696
Parameter Sets: (All)
97-
Aliases:
97+
Aliases:
9898

9999
Required: True
100100
Position: 0
@@ -109,7 +109,7 @@ Specifies the name of the database server.
109109
```yaml
110110
Type: String
111111
Parameter Sets: (All)
112-
Aliases:
112+
Aliases:
113113

114114
Required: True
115115
Position: 1

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Indicates that this cmdlet gets only defaults.
8686
```yaml
8787
Type: SwitchParameter
8888
Parameter Sets: DefaultResults
89-
Aliases:
89+
Aliases:
9090

9191
Required: False
9292
Position: Named
@@ -101,7 +101,7 @@ Specifies the name of the database edition for which this cmdlet gets capabiliti
101101
```yaml
102102
Type: String
103103
Parameter Sets: FilterResults
104-
Aliases:
104+
Aliases:
105105

106106
Required: False
107107
Position: Named
@@ -117,7 +117,7 @@ For more information, see Azure Regionshttp://azure.microsoft.com/en-us/regions/
117117
```yaml
118118
Type: String
119119
Parameter Sets: (All)
120-
Aliases:
120+
Aliases:
121121

122122
Required: True
123123
Position: 0
@@ -132,7 +132,7 @@ Specifies the name of the server version for which this cmdlet gets capabilities
132132
```yaml
133133
Type: String
134134
Parameter Sets: FilterResults
135-
Aliases:
135+
Aliases:
136136

137137
Required: False
138138
Position: Named
@@ -147,7 +147,7 @@ Specifies the name of the service objective for which this cmdlet gets capabilit
147147
```yaml
148148
Type: String
149149
Parameter Sets: FilterResults
150-
Aliases:
150+
Aliases:
151151

152152
Required: False
153153
Position: Named
@@ -199,4 +199,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
199199
## NOTES
200200
201201
## RELATED LINKS
202-

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Specifies the name of the resource group to which the database server is assigne
132132
```yaml
133133
Type: String
134134
Parameter Sets: (All)
135-
Aliases:
135+
Aliases:
136136

137137
Required: True
138138
Position: 0
@@ -147,7 +147,7 @@ Specifies the name of the server to which the database is assigned.
147147
```yaml
148148
Type: String
149149
Parameter Sets: (All)
150-
Aliases:
150+
Aliases:
151151

152152
Required: True
153153
Position: 1

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Specifies the name of the database for which this cmdlet gets status.
4646
```yaml
4747
Type: String
4848
Parameter Sets: (All)
49-
Aliases:
49+
Aliases:
5050

5151
Required: True
5252
Position: Named
@@ -76,7 +76,7 @@ Specifies the name of the elastic database pool for which this cmdlet gets statu
7676
```yaml
7777
Type: String
7878
Parameter Sets: (All)
79-
Aliases:
79+
Aliases:
8080

8181
Required: False
8282
Position: Named
@@ -91,7 +91,7 @@ Specifies the ID of the operation that this cmdlet gets.
9191
```yaml
9292
Type: Guid
9393
Parameter Sets: (All)
94-
Aliases:
94+
Aliases:
9595

9696
Required: False
9797
Position: Named
@@ -106,7 +106,7 @@ Specifies the name of the resource group to which the database is assigned.
106106
```yaml
107107
Type: String
108108
Parameter Sets: (All)
109-
Aliases:
109+
Aliases:
110110

111111
Required: True
112112
Position: 0
@@ -121,7 +121,7 @@ Specifies the name of the Microsoft SQL Server that hosts the database.
121121
```yaml
122122
Type: String
123123
Parameter Sets: (All)
124-
Aliases:
124+
Aliases:
125125

126126
Required: True
127127
Position: 1
@@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
173173
## NOTES
174174
175175
## RELATED LINKS
176-

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Specifies the name of the advisor that this cmdlet gets.
177177
```yaml
178178
Type: String
179179
Parameter Sets: (All)
180-
Aliases:
180+
Aliases:
181181

182182
Required: False
183183
Position: Named
@@ -192,7 +192,7 @@ Specifies the name of the database for which this cmdlet requests the Advisor.
192192
```yaml
193193
Type: String
194194
Parameter Sets: (All)
195-
Aliases:
195+
Aliases:
196196

197197
Required: True
198198
Position: Named
@@ -222,7 +222,7 @@ Indicates that this cmdlet gets the recommended actions with the response.
222222
```yaml
223223
Type: SwitchParameter
224224
Parameter Sets: (All)
225-
Aliases:
225+
Aliases:
226226

227227
Required: False
228228
Position: Named
@@ -237,7 +237,7 @@ Specifies the name of the resource group of the server that contains this databa
237237
```yaml
238238
Type: String
239239
Parameter Sets: (All)
240-
Aliases:
240+
Aliases:
241241

242242
Required: True
243243
Position: 0
@@ -252,7 +252,7 @@ Specifies the name of the server that contains the database.
252252
```yaml
253253
Type: String
254254
Parameter Sets: (All)
255-
Aliases:
255+
Aliases:
256256

257257
Required: True
258258
Position: Named

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ SQL Database name.
4747
```yaml
4848
Type: String
4949
Parameter Sets: (All)
50-
Aliases:
50+
Aliases:
5151

5252
Required: True
5353
Position: 2
@@ -77,7 +77,7 @@ The name of the resource group.
7777
```yaml
7878
Type: String
7979
Parameter Sets: (All)
80-
Aliases:
80+
Aliases:
8181

8282
Required: True
8383
Position: 0
@@ -92,7 +92,7 @@ SQL Database server name.
9292
```yaml
9393
Type: String
9494
Parameter Sets: (All)
95-
Aliases:
95+
Aliases:
9696

9797
Required: True
9898
Position: 1
@@ -143,4 +143,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
143143
## NOTES
144144
145145
## RELATED LINKS
146-

0 commit comments

Comments
 (0)