diff --git a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md index 4c1dde8c148a..5cec3ac01317 100644 --- a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md @@ -31,7 +31,38 @@ The **Set-AzSynapseLinkConnection** cmdlet creates or updates a link connections ### Example 1 ```powershell -Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\linkconnection.json" +<# +linkconnection.json +{ + "name":"sampleLinkConnection", // please change to your link connection name + "properties":{ + "sourceDatabase":{ + "typeProperties":{ // please change to your source database resourceId and principalId + "resourceId":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer", + "principalId":"xxxxxxxxxx" + }, + "linkedService":{ + "referenceName":"sampleLinkServiceReference", // please change to your source database link service name + "type":"LinkedServiceReference" + } + }, + "targetDatabase":{ + "linkedService":{ + "referenceName":"sampleLinkServiceReference", // please change to your target database link service name + "type":"LinkedServiceReference", + "parameters":{ + "DBName":"v2" + } + } + }, + "compute":{ + "coreCount":16, + "computeType":"General" + } + } +} +#> +Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\samples\linkconnection.json" ``` This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace. @@ -39,7 +70,7 @@ This command creates or updates a link connection from definition file linkconne ### Example 2 ```powershell $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace -$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\\samples\\linkconnection.json" +$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\samples\linkconnection.json" ``` This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace through pipeline. diff --git a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md index 3f253360f64c..41f28be40e05 100644 --- a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md +++ b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md @@ -39,7 +39,30 @@ The **Set-AzSynapseLinkConnectionLinkTables** cmdlet edits link tables under a l ### Example 1 ```powershell -Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" +<# +edittables.json +{ + "linkTables": [ + { + "id": "00000000000000000000000000000000", // please change to your link table Id: a uuid + "source": { + "tableName": "sampleSourceTable", // please change to your source table name + "schemaName": "sampleSourceSchema" // please change to your source database schema name + }, + "target": { + "tableName": "sampleTargetTable", // please change to your target table name + "schemaName": "sampleTargetSchema", // please change to your target database schema name + "distributionOptions": { + "type": "Round_RoBin", // please choose a type from Hash, Round_RoBin, Replicate + "distributionColumn": "sampleColumn" // please change to the column name + } + }, + "operationType": "add" // please choose a value from add, update, remove + } + ] +} +#> +Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json" ``` This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace. @@ -49,7 +72,7 @@ This file includes information about edited link table. ### Example 2 ```powershell $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace -$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" +$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json" ``` 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. ### Example 3 ```powershell $lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection -$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\\samples\\edittables.json" +$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\samples\edittables.json" ``` This command edits link tables under a link connection through pipeline.