Set-AzSynapseLinkConnectionLinkTable
Edits link tables under a link connection.
Syntax
Set-AzSynapseLinkConnectionLinkTable
-WorkspaceName <String>
-EditTablesRequestFile <String>
-LinkConnectionName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSynapseLinkConnectionLinkTable
-WorkspaceObject <PSSynapseWorkspace>
-EditTablesRequestFile <String>
-LinkConnectionName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzSynapseLinkConnectionLinkTable
-EditTablesRequestFile <String>
-InputObject <PSLinkConnectionResource>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzSynapseLinkConnectionLinkTables cmdlet edits link tables under a link connection.
Examples
Example 1
<#
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. The command bases the link tables on information in the edittables.json file. This file includes information about edited link table.
Example 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\samples\edittables.json"This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. The command bases the link tables on information in the edittables.json file. This file includes information about edited link table.
Example 3
$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\samples\edittables.json"This command edits link tables under a link connection through pipeline. The command bases the link tables on information in the edittables.json file. This file includes information about edited link table.
Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EditTablesRequestFile
Specifies a local file path for a file to edit link tables
| Type: | String |
| Aliases: | File |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The information about the link connection.
| Type: | PSLinkConnectionResource |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LinkConnectionName
Name of link connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceName
Name of Synapse workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceObject
workspace input object, usually passed through the pipeline.
| Type: | PSSynapseWorkspace |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell