Skip to content

Commit 79d1b67

Browse files
committed
regenerate sql help files
1 parent 50359cd commit 79d1b67

File tree

136 files changed

+2781
-505
lines changed

Some content is hidden

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

136 files changed

+2781
-505
lines changed

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml
3+
Module Name: AzureRM.Sql
34
online version:
45
schema: 2.0.0
56
---
@@ -14,7 +15,7 @@ Adds one or more databases to an Azure SQL Database Failover Group.
1415
```
1516
Add-AzureRmSqlDatabaseToFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String>
1617
-Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]>
17-
[-ResourceGroupName] <String> [<CommonParameters>]
18+
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -67,6 +68,21 @@ Accept pipeline input: True (ByValue)
6768
Accept wildcard characters: False
6869
```
6970
71+
### -DefaultProfile
72+
The credentials, account, tenant, and subscription used for communication with azure
73+
74+
```yaml
75+
Type: IAzureContextContainer
76+
Parameter Sets: (All)
77+
Aliases: AzureRmContext, AzureCredential
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
7086
### -FailoverGroupName
7187
The name of the Azure SQL Database Failover Group.
7288

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml
3+
Module Name: AzureRM.Sql
34
online version:
45
schema: 2.0.0
56
---
@@ -13,7 +14,7 @@ Adds a Key Vault key to a SQL server.
1314

1415
```
1516
Add-AzureRmSqlServerKeyVaultKey [-KeyId] <String> [-ServerName] <String> [-ResourceGroupName] <String>
16-
[-WhatIf] [-Confirm] [<CommonParameters>]
17+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -39,6 +40,21 @@ CreationDate : 1/1/2017 12:00:00 AM
3940

4041
## PARAMETERS
4142

43+
### -DefaultProfile
44+
The credentials, account, tenant, and subscription used for communication with azure
45+
46+
```yaml
47+
Type: IAzureContextContainer
48+
Parameter Sets: (All)
49+
Aliases: AzureRmContext, AzureCredential
50+
51+
Required: False
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
4258
### -KeyId
4359
The Azure Key Vault KeyId.
4460

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

Lines changed: 76 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Gets the status of moving elastic databases.
2929
### [Get-AzureRmSqlDatabaseAdvisor](Get-AzureRmSqlDatabaseAdvisor.md)
3030
Gets one or more Advisors for an Azure SQL Database.
3131

32+
### [Get-AzureRmSqlDatabaseAuditing](Get-AzureRmSqlDatabaseAuditing.md)
33+
Gets the auditing settings of an Azure SQL database.
34+
3235
### [Get-AzureRmSqlDatabaseAuditingPolicy](Get-AzureRmSqlDatabaseAuditingPolicy.md)
3336
Gets the auditing policy of a database.
3437

@@ -113,6 +116,9 @@ Gets information about an Azure AD administrator for SQL Server.
113116
### [Get-AzureRmSqlServerAdvisor](Get-AzureRmSqlServerAdvisor.md)
114117
Gets one or more Advisors for an Azure SQL Server.
115118

119+
### [Get-AzureRmSqlServerAuditing](Get-AzureRmSqlServerAuditing.md)
120+
Gets the auditing settings of an Azure SQL server.
121+
116122
### [Get-AzureRmSqlServerAuditingPolicy](Get-AzureRmSqlServerAuditingPolicy.md)
117123
Gets the auditing policy of a SQL server.
118124

@@ -152,6 +158,27 @@ Gets the status of an Azure SQL Database server upgrade.
152158
### [Get-AzureRmSqlServerUpgradeHint](Get-AzureRmSqlServerUpgradeHint.md)
153159
Gets pricing tier hints for upgrading an Azure SQL Database server.
154160

161+
### [Get-AzureRmSqlServerVirtualNetworkRule](Get-AzureRmSqlServerVirtualNetworkRule.md)
162+
Gets or lists Azure SQL Server Virtual Network Rule.
163+
164+
### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md)
165+
Returns information about Azure SQL Sync Agents.
166+
167+
### [Get-AzureRmSqlSyncAgentLinkedDatabase](Get-AzureRmSqlSyncAgentLinkedDatabase.md)
168+
Returns information about SQL Server databases linked by a sync agent.
169+
170+
### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md)
171+
Returns information about Azure SQL Database Sync Groups.
172+
173+
### [Get-AzureRmSqlSyncGroupLog](Get-AzureRmSqlSyncGroupLog.md)
174+
Returns the logs of an Azure SQL Database Sync Group.
175+
176+
### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md)
177+
Returns information about Azure SQL Database Sync Members.
178+
179+
### [Get-AzureRmSqlSyncSchema](Get-AzureRmSqlSyncSchema.md)
180+
Returns information about the sync schema of a member database or a hub database.
181+
155182
### [New-AzureRmSqlDatabase](New-AzureRmSqlDatabase.md)
156183
Creates a database or an elastic database.
157184

@@ -188,6 +215,21 @@ Creates a database server system recovery configuration.
188215
### [New-AzureRmSqlServerFirewallRule](New-AzureRmSqlServerFirewallRule.md)
189216
Creates a firewall rule for a SQL Database server.
190217

218+
### [New-AzureRmSqlServerVirtualNetworkRule](New-AzureRmSqlServerVirtualNetworkRule.md)
219+
Creates an Azure SQL Server Virtual Network Rule.
220+
221+
### [New-AzureRmSqlSyncAgent](New-AzureRmSqlSyncAgent.md)
222+
Creates an Azure SQL Sync Agent.
223+
224+
### [New-AzureRmSqlSyncAgentKey](New-AzureRmSqlSyncAgentKey.md)
225+
Creates an Azure SQL Sync Agent Key.
226+
227+
### [New-AzureRmSqlSyncGroup](New-AzureRmSqlSyncGroup.md)
228+
Creates an Azure SQL Database Sync Group.
229+
230+
### [New-AzureRmSqlSyncMember](New-AzureRmSqlSyncMember.md)
231+
Creates an Azure SQL Database Sync Member.
232+
191233
### [Remove-AzureRmSqlDatabase](Remove-AzureRmSqlDatabase.md)
192234
Removes an Azure SQL database.
193235

@@ -236,6 +278,18 @@ Removes a Key Vault key from a SQL server.
236278
### [Remove-AzureRmSqlServerThreatDetectionPolicy](Remove-AzureRmSqlServerThreatDetectionPolicy.md)
237279
Removes the threat detection policy from a server.
238280

281+
### [Remove-AzureRmSqlServerVirtualNetworkRule](Remove-AzureRmSqlServerVirtualNetworkRule.md)
282+
Deletes an Azure SQL Server Virtual Network Rule.
283+
284+
### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md)
285+
Removes an Azure SQL Sync Agent.
286+
287+
### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md)
288+
Removes an Azure SQL Database Sync Group.
289+
290+
### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md)
291+
Removes an Azure SQL Database Sync Member.
292+
239293
### [Restore-AzureRmSqlDatabase](Restore-AzureRmSqlDatabase.md)
240294
Restores a SQL database.
241295

@@ -248,6 +302,9 @@ Sets properties for a database, or moves an existing database into an elastic po
248302
### [Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus](Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md)
249303
Modifies auto execute status of an Azure SQL Database Advisor.
250304

305+
### [Set-AzureRmSqlDatabaseAuditing](Set-AzureRmSqlDatabaseAuditing.md)
306+
Changes the auditing settings for an Azure SQL database.
307+
251308
### [Set-AzureRmSqlDatabaseAuditingPolicy](Set-AzureRmSqlDatabaseAuditingPolicy.md)
252309
Sets the auditing policy for a database.
253310

@@ -279,7 +336,7 @@ Sets a threat detection policy on a database.
279336
Modifies TDE property for a database.
280337

281338
### [Set-AzureRmSqlElasticPool](Set-AzureRmSqlElasticPool.md)
282-
Modifies properties of an elastic database pool in a SQL Database.
339+
Modifies properties of an elastic database pool in Azure SQL Database.
283340

284341
### [Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md)
285342
Updates auto execute status of an Azure SQL Elastic Pool Advisor.
@@ -296,6 +353,9 @@ Provisions an Azure AD administrator for SQL Server.
296353
### [Set-AzureRmSqlServerAdvisorAutoExecuteStatus](Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md)
297354
Updates the auto execute status of an Azure SQL Server Advisor.
298355

356+
### [Set-AzureRmSqlServerAuditing](Set-AzureRmSqlServerAuditing.md)
357+
Changes the auditing settings of an Azure SQL server.
358+
299359
### [Set-AzureRmSqlServerAuditingPolicy](Set-AzureRmSqlServerAuditingPolicy.md)
300360
Changes the auditing policy of a SQL Database server.
301361

@@ -317,71 +377,44 @@ Sets a threat detection policy on a server.
317377
### [Set-AzureRmSqlServerTransparentDataEncryptionProtector](Set-AzureRmSqlServerTransparentDataEncryptionProtector.md)
318378
Sets the Transparent Data Encryption (TDE) protector for a SQL server.
319379

380+
### [Set-AzureRmSqlServerVirtualNetworkRule](Set-AzureRmSqlServerVirtualNetworkRule.md)
381+
Modifies the configuration of an Azure SQL Server Virtual Network Rule.
382+
320383
### [Start-AzureRmSqlDatabaseExecuteIndexRecommendation](Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md)
321384
Starts the workflow that runs a recommended index operation.
322385

323386
### [Start-AzureRmSqlServerUpgrade](Start-AzureRmSqlServerUpgrade.md)
324387
Starts the upgrade of a SQL Database server.
325388

389+
### [Start-AzureRmSqlSyncGroupSync](Start-AzureRmSqlSyncGroupSync.md)
390+
Starts a sync group synchronization.
391+
326392
### [Stop-AzureRmSqlDatabaseExecuteIndexRecommendation](Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md)
327393
Stops the workflow that runs a recommended index operation.
328394

329395
### [Stop-AzureRmSqlServerUpgrade](Stop-AzureRmSqlServerUpgrade.md)
330396
Stops the upgrade of a SQL Database server.
331397

398+
### [Stop-AzureRmSqlSyncGroupSync](Stop-AzureRmSqlSyncGroupSync.md)
399+
Stops a sync group synchronization.
400+
332401
### [Suspend-AzureRmSqlDatabase](Suspend-AzureRmSqlDatabase.md)
333402
Suspends a SQL Data Warehouse database.
334403

335404
### [Switch-AzureRmSqlDatabaseFailoverGroup](Switch-AzureRmSqlDatabaseFailoverGroup.md)
336405
Executes a failover of an Azure SQL Database Failover Group.
337406

338-
### [Use-AzureRmSqlServerAuditingPolicy](Use-AzureRmSqlServerAuditingPolicy.md)
339-
Specifies that a database uses the auditing policy of its host server.
340-
341-
### [New-AzureRmSqlSyncGroup](New-AzureRmSqlSyncGroup.md)
342-
Creates an Azure SQL Database Sync Group.
343-
344407
### [Update-AzureRmSqlSyncGroup](Update-AzureRmSqlSyncGroup.md)
345408
Updates an Azure SQL Database Sync Group.
346409

347-
### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md)
348-
Returns information about Azure SQL Database Sync Groups.
349-
350-
### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md)
351-
Removes an Azure SQL Database Sync Group.
352-
353-
### [Start-AzureRmSqlSyncGroupSync](Start-AzureRmSqlSyncGroupSync.md)
354-
Starts a sync group synchronization.
355-
356-
### [Stop-AzureRmSqlSyncGroupSync](Stop-AzureRmSqlSyncGroupSync.md)
357-
Stops a sync group synchronization.
358-
359-
### [Get-AzureRmSqlSyncGroupLog](Get-AzureRmSqlSyncGroupLog.md)
360-
Returns the logs of an Azure SQL Database Sync Group.
361-
362-
### [New-AzureRmSqlSyncMember](New-AzureRmSqlSyncMember.md)
363-
Creates an Azure SQL Database Sync Member.
364-
365410
### [Update-AzureRmSqlSyncMember](Update-AzureRmSqlSyncMember.md)
366411
Updates an Azure SQL Database Sync Member.
367412

368-
### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md)
369-
Returns information about Azure SQL Database Sync Members.
370-
371-
### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md)
372-
Removes an Azure SQL Database Sync Member.
373-
374-
### [New-AzureRmSqlSyncAgent](New-AzureRmSqlSyncAgent.md)
375-
Creates an Azure SQL Sync Agent.
413+
### [Update-AzureRmSqlSyncSchema](Update-AzureRmSqlSyncSchema.md)
414+
Update the sync schema for a sync member database or a sync hub database.
415+
It will get the the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database.
416+
If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema.
376417

377-
### [New-AzureRmSqlSyncAgentKey](New-AzureRmSqlSyncAgentKey.md)
378-
Creates an Azure SQL Sync Agent Key.
379-
380-
### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md)
381-
Returns information about Azure SQL Sync Agents.
382-
383-
### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md)
384-
Removes an Azure SQL Sync Agent.
418+
### [Use-AzureRmSqlServerAuditingPolicy](Use-AzureRmSqlServerAuditingPolicy.md)
419+
Specifies that a database uses the auditing policy of its host server.
385420

386-
### [Get-AzureRmSqlSyncAgentLinkedDatabase](Get-AzureRmSqlSyncAgentLinkedDatabase.md)
387-
Returns information about SQL Server databases linked by a sync agent.

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml
3+
Module Name: AzureRM.Sql
34
ms.assetid: 256AA6F4-D856-4713-A0AC-0DA1A145AA5C
45
online version:
56
schema: 2.0.0
@@ -14,7 +15,7 @@ Gets a geo-redundant backup of a database.
1415

1516
```
1617
Get-AzureRmSqlDatabaseGeoBackup [-ServerName] <String> [[-DatabaseName] <String>] [-ResourceGroupName] <String>
17-
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -58,6 +59,21 @@ Accept pipeline input: True (ByPropertyName)
5859
Accept wildcard characters: False
5960
```
6061
62+
### -DefaultProfile
63+
The credentials, account, tenant, and subscription used for communication with azure
64+
65+
```yaml
66+
Type: IAzureContextContainer
67+
Parameter Sets: (All)
68+
Aliases: AzureRmContext, AzureCredential
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
6177
### -ResourceGroupName
6278
Specifies the name of the resource group to which the SQL database server is assigned.
6379

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml
3+
Module Name: AzureRM.Sql
34
ms.assetid: 62B9754D-5EBF-4BEE-B07A-3E508C918F03
45
online version:
56
schema: 2.0.0
@@ -14,7 +15,8 @@ Gets a deleted database that you can restore.
1415

1516
```
1617
Get-AzureRmSqlDeletedDatabaseBackup [-ServerName] <String> [[-DatabaseName] <String>]
17-
[[-DeletionDate] <DateTime>] [-ResourceGroupName] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[[-DeletionDate] <DateTime>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>]
19+
[-WhatIf] [-Confirm] [<CommonParameters>]
1820
```
1921

2022
## DESCRIPTION
@@ -55,6 +57,21 @@ Accept pipeline input: True (ByPropertyName)
5557
Accept wildcard characters: False
5658
```
5759
60+
### -DefaultProfile
61+
The credentials, account, tenant, and subscription used for communication with azure
62+
63+
```yaml
64+
Type: IAzureContextContainer
65+
Parameter Sets: (All)
66+
Aliases: AzureRmContext, AzureCredential
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
5875
### -DeletionDate
5976
Specifies the date, as a **DateTime** object, that the database was deleted.
6077
To get a **DateTime** object, use the Get-Date cmdlet.

0 commit comments

Comments
 (0)