Skip to content

Commit 8616829

Browse files
authored
[Synapse] Updated help doc for [Set-AzSynapseLinkConnection] and [Set-AzSynapseLinkConnectionLinkTable] (Azure#19144)
* update help doc for set link connection cmdlets * remove escaped back slash
1 parent af94f6c commit 8616829

File tree

2 files changed

+59
-5
lines changed

2 files changed

+59
-5
lines changed

src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,46 @@ The **Set-AzSynapseLinkConnection** cmdlet creates or updates a link connections
3131

3232
### Example 1
3333
```powershell
34-
Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\linkconnection.json"
34+
<#
35+
linkconnection.json
36+
{
37+
"name":"sampleLinkConnection", // please change to your link connection name
38+
"properties":{
39+
"sourceDatabase":{
40+
"typeProperties":{ // please change to your source database resourceId and principalId
41+
"resourceId":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer",
42+
"principalId":"xxxxxxxxxx"
43+
},
44+
"linkedService":{
45+
"referenceName":"sampleLinkServiceReference", // please change to your source database link service name
46+
"type":"LinkedServiceReference"
47+
}
48+
},
49+
"targetDatabase":{
50+
"linkedService":{
51+
"referenceName":"sampleLinkServiceReference", // please change to your target database link service name
52+
"type":"LinkedServiceReference",
53+
"parameters":{
54+
"DBName":"v2"
55+
}
56+
}
57+
},
58+
"compute":{
59+
"coreCount":16,
60+
"computeType":"General"
61+
}
62+
}
63+
}
64+
#>
65+
Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\linkconnection.json"
3566
```
3667

3768
This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace.
3869

3970
### Example 2
4071
```powershell
4172
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
42-
$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\\samples\\linkconnection.json"
73+
$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\samples\linkconnection.json"
4374
```
4475

4576
This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace through pipeline.

src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,30 @@ The **Set-AzSynapseLinkConnectionLinkTables** cmdlet edits link tables under a l
3939

4040
### Example 1
4141
```powershell
42-
Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json"
42+
<#
43+
edittables.json
44+
{
45+
"linkTables": [
46+
{
47+
"id": "00000000000000000000000000000000", // please change to your link table Id: a uuid
48+
"source": {
49+
"tableName": "sampleSourceTable", // please change to your source table name
50+
"schemaName": "sampleSourceSchema" // please change to your source database schema name
51+
},
52+
"target": {
53+
"tableName": "sampleTargetTable", // please change to your target table name
54+
"schemaName": "sampleTargetSchema", // please change to your target database schema name
55+
"distributionOptions": {
56+
"type": "Round_RoBin", // please choose a type from Hash, Round_RoBin, Replicate
57+
"distributionColumn": "sampleColumn" // please change to the column name
58+
}
59+
},
60+
"operationType": "add" // please choose a value from add, update, remove
61+
}
62+
]
63+
}
64+
#>
65+
Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json"
4366
```
4467

4568
This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace.
@@ -49,7 +72,7 @@ This file includes information about edited link table.
4972
### Example 2
5073
```powershell
5174
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
52-
$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json"
75+
$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json"
5376
```
5477

5578
This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline.
@@ -59,7 +82,7 @@ This file includes information about edited link table.
5982
### Example 3
6083
```powershell
6184
$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
62-
$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\\samples\\edittables.json"
85+
$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\samples\edittables.json"
6386
```
6487

6588
This command edits link tables under a link connection through pipeline.

0 commit comments

Comments
 (0)