Set-AzSynapseLinkConnectionLinkTable

Module:

Az.Synapse Module

Edits link tables under a link connection.

Syntax

SetByName (Default)

Set-AzSynapseLinkConnectionLinkTable
    -WorkspaceName <String>
    -EditTablesRequestFile <String>
    -LinkConnectionName <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByObject

Set-AzSynapseLinkConnectionLinkTable
    -WorkspaceObject <PSSynapseWorkspace>
    -EditTablesRequestFile <String>
    -LinkConnectionName <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByInputObject

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-EditTablesRequestFile

Specifies a local file path for a file to edit link tables

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	File

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The information about the link connection.

Parameter properties

Type:	PSLinkConnectionResource
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByInputObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LinkConnectionName

Name of link connection.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

SetByObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseWorkspace
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

PSLinkConnectionResource

Outputs

Void