Skip to content

Commit 3dc64f8

Browse files
fanglfangl
authored andcommitted
Update help doc
1 parent 55aab78 commit 3dc64f8

20 files changed

+182
-189
lines changed

src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml

Lines changed: 108 additions & 108 deletions
Large diffs are not rendered by default.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ Creates an Azure SQL Database Sync Group.
345345
Updates an Azure SQL Database Sync Group.
346346

347347
### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md)
348-
Returns information about SQL Database Sync Groups.
348+
Returns information about Azure SQL Database Sync Groups.
349349

350350
### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md)
351351
Removes an Azure SQL Database Sync Group.
@@ -363,10 +363,10 @@ Returns the logs of an Azure SQL Database Sync Group.
363363
Creates an Azure SQL Database Sync Member.
364364

365365
### [Set-AzureRmSqlSyncMember](Set-AzureRmSqlSyncMember.md)
366-
Updates an Azure SQL Database Sync Member
366+
Updates an Azure SQL Database Sync Member.
367367

368368
### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md)
369-
Returns information about SQL Database Sync Members.
369+
Returns information about Azure SQL Database Sync Members.
370370

371371
### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md)
372372
Removes an Azure SQL Database Sync Member.
@@ -378,7 +378,7 @@ Creates an Azure SQL Sync Agent.
378378
Creates an Azure SQL Sync Agent Key.
379379

380380
### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md)
381-
Returns information about SQL Database Sync Agents.
381+
Returns information about Azure SQL Sync Agents.
382382

383383
### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md)
384384
Removes an Azure SQL Sync Agent.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmSqlSyncAgent
88

99
## SYNOPSIS
10-
Returns information about SQL Database Sync Agents.
10+
Returns information about Azure SQL Sync Agents.
1111

1212
## SYNTAX
1313
```
@@ -16,11 +16,11 @@ Get-AzureRmSqlSyncAgent [-SyncAgentName <String>] [-ServerName] <String> [-Resou
1616

1717
## DESCRIPTION
1818
The **Get-AzureRmSqlSyncAgent** cmdlet returns information about one or more Azure SQL Sync Agents.
19-
Specify the name of a sync agent to see information for only that sync sync agent.
19+
Specify the name of a sync agent to see information for only that sync agent.
2020

2121
## EXAMPLES
2222

23-
### Example 1: Get all instances of SQL Sync Agent assigned to a SQL Azure Server
23+
### Example 1: Get all instances of Azure SQL Sync Agent assigned to an Azure SQL Server
2424
```
2525
PS C:\>Get-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01"
2626
ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01}
@@ -48,7 +48,7 @@ ExpiryTime :
4848
State : Good
4949
```
5050

51-
This command gets information about all the Azure SQL Database Sync Agents assigned to an SQL Azure Server.
51+
This command gets information about all the Azure SQL Sync Agents assigned to an Azure SQL Server.
5252

5353
### Example 2: Get information about an Azure SQL Sync Agent
5454
```
@@ -86,7 +86,7 @@ Accept wildcard characters: False
8686
```
8787
8888
### -ServerName
89-
The name of the Azure SQL Database Server the sync agent is in.
89+
The name of the Azure SQL Server the sync agent is in.
9090
9191
```yaml
9292
Type: String

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The **Get-AzureRmSqlSyncAgentLinkedDatabases** cmdlet returns information about
2121

2222
## EXAMPLES
2323

24-
### Example 1: Get the linked SQL Server databases for a SQL Azure sync agent.
24+
### Example 1: Get the linked SQL Server databases for an Azure SQL sync agent.
2525
```
2626
PS C:\> Get-AzureRmSqlSyncAgentLinkedDatabases -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01"
2727
SeverName : "sever01"
@@ -32,7 +32,7 @@ Description : ""
3232
UserName : ""
3333
```
3434

35-
This command returns the linked SQL Server databases linked by an Azure Sync Agent.
35+
This command returns the linked SQL Server databases linked by an Azure SQL sync agent.
3636

3737

3838
## PARAMETERS

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmSqlSyncGroup
88

99
## SYNOPSIS
10-
Returns information about SQL Database Sync Groups.
10+
Returns information about Azure SQL Database Sync Groups.
1111

1212
## SYNTAX
1313

@@ -23,7 +23,7 @@ Specify the name of a sync group to see information for only that sync group.
2323
## EXAMPLES
2424

2525

26-
### Example 1: Get all instances of SQL Sync Group assigned to a SQL Azure database
26+
### Example 1: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database
2727
```
2828
PS C:\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
2929
ResourceId : /subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}
@@ -55,7 +55,7 @@ LastSyncTime :
5555
Schema :
5656
```
5757

58-
This command gets information about all the Azure SQL Database Sync Group assigned to an SQL Azure database.
58+
This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database.
5959

6060
### Example 2: Get information about an Azure SQL Database Sync Group
6161
```
@@ -80,7 +80,7 @@ This command gets information about the Azure SQL Database Sync Group with name
8080
## PARAMETERS
8181

8282
### -DatabaseName
83-
SQL Database name.
83+
The name of the Azure SQL Database.
8484

8585
```yaml
8686
Type: String
@@ -110,7 +110,7 @@ Accept wildcard characters: False
110110
```
111111
112112
### -ServerName
113-
SQL Database server name.
113+
The name of the Azure SQL server.
114114
115115
```yaml
116116
Type: String

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Returns the logs of an Azure SQL Database Sync Group.
1212
## SYNTAX
1313

1414
```
15-
Get-AzureRmSqlSyncGroupLog -SyncGroupName <String> -StartTime <String> [-EndTime <String>] -Type <String>
15+
Get-AzureRmSqlSyncGroupLog -SyncGroupName <String> -StartTime <String> [-EndTime <String>] [-Type <String>]
1616
[-ServerName] <String> [-DatabaseName] <String> [-ResourceGroupName] <String> [-WhatIf] [-Confirm]
1717
```
1818

@@ -21,7 +21,7 @@ The **Get-AzureRmSqlSyncGroupLog** cmdlet returns the logs of an Azure SQL Datab
2121

2222
## EXAMPLES
2323

24-
### Example 1: Get the logs of a SQL Azure Sync Group
24+
### Example 1: Get the logs of an Azure SQL Sync Group
2525
```
2626
PS C:\>Get-AzureRmSqlSyncGroupLog -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01" -StartTime "9/16/2016 11:31:12" -EndTime "9/16/2016 12:31:00" -Type "All"
2727
[{
@@ -40,7 +40,7 @@ Source : SyncMemberLogs
4040
]
4141
```
4242

43-
This command gets the logs of a SQL Azure Sync Group.
43+
This command gets the logs of an Azure SQL Sync Group.
4444

4545
## PARAMETERS
4646

@@ -60,7 +60,7 @@ Accept wildcard characters: False
6060
```
6161
6262
### -DatabaseName
63-
SQL Database name.
63+
The name of the Azure SQL Database.
6464
6565
```yaml
6666
Type: String
@@ -105,7 +105,7 @@ Accept wildcard characters: False
105105
```
106106
107107
### -ServerName
108-
SQL Database server name.
108+
The name of the Azure SQL server.
109109
110110
```yaml
111111
Type: String

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmSqlSyncMember
88

99
## SYNOPSIS
10-
Returns information about SQL Database Sync Members.
10+
Returns information about Azure SQL Database Sync Members.
1111

1212
## SYNTAX
1313

@@ -22,7 +22,7 @@ Specify the name of a sync member to see information for only that sync member.
2222

2323
## EXAMPLES
2424

25-
### Example 1: Get all instances of SQL Sync Member assigned to a sync group
25+
### Example 1: Get all instances of Azure SQL Sync Member assigned to a sync group
2626
```
2727
PS C:\>Get-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SyncGroupName "SyncGroup01"
2828
ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/databases/{Database01}/syncGroups/{SyncGroup01}/syncMembers/{SyncMember01}
@@ -85,7 +85,7 @@ This command gets information about the Azure SQL Database Sync Member with name
8585
## PARAMETERS
8686

8787
### -DatabaseName
88-
SQL Database name.
88+
The name of the Azure SQL Database.
8989

9090
```yaml
9191
Type: String
@@ -115,7 +115,7 @@ Accept wildcard characters: False
115115
```
116116
117117
### -ServerName
118-
SQL Database server name.
118+
The name of the Azure SQL server.
119119
120120
```yaml
121121
Type: String

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,21 @@ Tables {
4242
}]
4343
```
4444

45-
This command gets the sync schema schema for the hub database in the sync group syncGroup01.
45+
This command gets the sync schema for the hub database in the sync group syncGroup01.
4646

4747

4848
### Example 2: Get the sync schema for a member database
4949
```
5050
PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01"
5151
The schema payload is the same as Example 1.
5252
```
53-
This command gets the sync schema schema for the member database in the sync member syncMember01.
53+
This command gets the sync schema for the member database in the sync member syncMember01.
5454

5555

5656
## PARAMETERS
5757

5858
### -DatabaseName
59-
SQL Database name.
59+
The name of the Azure SQL Database.
6060

6161
```yaml
6262
Type: String
@@ -86,7 +86,7 @@ Accept wildcard characters: False
8686
```
8787
8888
### -ServerName
89-
SQL Database server name.
89+
The name of the Azure SQL server.
9090
9191
```yaml
9292
Type: String

src/ResourceManager/Sql/Commands.Sql/help/Invoke-AzureRmSqlSyncSchemaRefresh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This command invokes the sync schema refresh for the member database in the sync
3939
## PARAMETERS
4040

4141
### -DatabaseName
42-
SQL Database name.
42+
The name of the Azure SQL Database.
4343

4444
```yaml
4545
Type: String
@@ -69,7 +69,7 @@ Accept wildcard characters: False
6969
```
7070
7171
### -ServerName
72-
SQL Database server name.
72+
The name of the Azure SQL server.
7373
7474
```yaml
7575
Type: String

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Creates an Azure SQL Sync Agent.
1212
## SYNTAX
1313

1414
```
15-
New-AzureRmSqlSyncAgent -SyncAgentName <String> [-SyncDatabaseName <String>] [-SyncDatabaseServerName <String>]
15+
New-AzureRmSqlSyncAgent -SyncAgentName <String> -SyncDatabaseName <String> [-SyncDatabaseServerName <String>]
1616
[-SyncDatabaseResourceGroupName <String>] [-ServerName] <String> [-ResourceGroupName] <String>
1717
```
1818

@@ -21,7 +21,7 @@ The **New-AzureRmSqlSyncAgent** cmdlet creates an Azure SQL Sync Agent.
2121

2222
## EXAMPLES
2323

24-
### Example 1: Create a sync agent for a SQL Azure database server.
24+
### Example 1: Create a sync agent for an Azure SQL server.
2525
```
2626
PS C:\> New-AzureRmSqlSyncAgent -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01" -SyncDatabaseServerName "syncDatabaseServer01" -SyncDatabaseName "syncDatabaseName01" -SyncDatabaseResourceGroupName "syncDatabaseResourceGroup01"
2727
ResourceId : subscriptions/{subscriptionId}/resourceGroups/{ResourceGroup01}/servers/{Server01}/syncAgents/{SyncAgent01}
@@ -37,7 +37,7 @@ ExpiryTime :
3737
State : Good
3838
```
3939

40-
This command creates a sync agent for a SQL Azure database server.
40+
This command creates a sync agent for an Azure SQL server.
4141

4242
## PARAMETERS
4343

@@ -57,7 +57,7 @@ Accept wildcard characters: False
5757
```
5858
5959
### -ServerName
60-
The name of the Azure SQL Database Server the sync agent is in.
60+
The name of the Azure SQL Server the sync agent is in.
6161
6262
```yaml
6363
Type: String
@@ -102,7 +102,7 @@ Accept wildcard characters: False
102102
```
103103
104104
### -SyncDatabaseResourceGroupName
105-
The resource group sync metadata database belongs to.
105+
The resource group the sync metadata database belongs to.
106106
107107
```yaml
108108
Type: String
@@ -117,7 +117,7 @@ Accept wildcard characters: False
117117
```
118118
119119
### -SyncDatabaseServerName
120-
The server on which sync metadata database is hosted.
120+
The server on which the sync metadata database is hosted.
121121
122122
```yaml
123123
Type: String

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ The **New-AzureRmSqlSyncAgentKey** cmdlet creates an Azure SQL Sync Agent key.
2020

2121
## EXAMPLES
2222

23-
### Example 1: Create a sync agent key for a SQL Azure sync agent.
23+
### Example 1: Create a sync agent key for an Azure SQL sync agent.
2424
```
2525
PS C:\> New-AzureRmSqlSyncAgentKey -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -SyncAgentName "SyncAgent01"
2626
SyncAgentKey : "Key"
2727
```
2828

29-
This command creates a sync agent key for a SQL Azure Sync Agent.
29+
This command creates a sync agent key for an Azure SQL Sync Agent.
3030

3131
## PARAMETERS
3232

@@ -46,7 +46,7 @@ Accept wildcard characters: False
4646
```
4747
4848
### -ServerName
49-
The name of the Azure SQL Database Server the sync agent is in.
49+
The name of the Azure SQL Server the sync agent is in.
5050
5151
```yaml
5252
Type: String

0 commit comments

Comments
 (0)