az synapse link-connection

Manage Synapse's link connection.

Commands

Name	Description	Type	Status
az synapse link-connection create	Create a link connection.	Core	GA
az synapse link-connection delete	Delete a link connection.	Core	GA
az synapse link-connection edit-link-tables	Edit tables for a link connection.	Core	GA
az synapse link-connection get-link-tables-status	Query the link table status of a link connection.	Core	GA
az synapse link-connection get-status	Check a link connection status after start/stop a link connection.	Core	GA
az synapse link-connection list	List link connections in a synapse workspace.	Core	GA
az synapse link-connection list-link-tables	List the link tables of a link connection.	Core	GA
az synapse link-connection show	Get a link connection.	Core	GA
az synapse link-connection start	Start a link connnection.	Core	GA
az synapse link-connection stop	Stop a link connection.	Core	GA
az synapse link-connection update	Update a link connection.	Core	GA
az synapse link-connection update-landing-zone-credential	Update landing zone credetial of a link connection.	Core	GA

az synapse link-connection create

Create a link connection.

az synapse link-connection create --file
                                  --name
                                  --workspace-name

Examples

Create a link connection. Definition.json sample is { "name":"sampleLinkConnection", // please change to your link connection name "properties":{ "sourceDatabase":{ "typeProperties":{ // please change to your source database resourceId and principalId "resourceId":"/subscriptions/sampleSubscriptionId/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" } } }

az synapse link-connection create --workspace-name testsynapseworkspace \
  --name testlinkconnectionname \
  --file @"path/definition.json"

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection delete

Delete a link connection.

az synapse link-connection delete --name
                                  --workspace-name

Examples

Delete a link connection.

az synapse link-connection delete --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection edit-link-tables

Edit tables for a link connection.

az synapse link-connection edit-link-tables --file
                                            --name
                                            --workspace-name

Examples

Edit tables for a link connection. the file pattern should be { "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 } ] }

az synapse link-connection edit-link-tables --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --file @path/edittablerequestfile.json

Required Parameters

--file -f

The Edit link-tables file path, The file format can be viewed using --help.

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection get-link-tables-status

Query the link table status of a link connection.

az synapse link-connection get-link-tables-status --name
                                                  --workspace-name
                                                  [--continuation-token]
                                                  [--max-segment-count]

Examples

Query the link table status of a link connection.

az synapse link-connection get-link-tables-status --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --max-segment-count 50 \
  --continuation-token token

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Optional Parameters

--continuation-token

Continuation token to query table status.

--max-segment-count

Max segment count to query table status.

Default value: 50

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection get-status

Check a link connection status after start/stop a link connection.

az synapse link-connection get-status --name
                                      --workspace-name

Examples

Stop a link connection.

az synapse link-connection get-status --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection list

List link connections in a synapse workspace.

az synapse link-connection list --workspace-name

Examples

List link connections.

az synapse link-connection list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection list-link-tables

List the link tables of a link connection.

az synapse link-connection list-link-tables --name
                                            --workspace-name

Examples

List the link tables of a link connection.

az synapse link-connection list-link-tables --workspace-name testsynapseworkspace \
  --name linkconnectionname \

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection show

Get a link connection.

az synapse link-connection show --name
                                --workspace-name

Examples

Get a link-connection.

az synapse link-connection show --workspace-name testsynapseworkspace \
  --name testlinkconectionname

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection start

Start a link connnection.

az synapse link-connection start --name
                                 --workspace-name

Examples

Start a link connection.

az synapse link-connection start --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection stop

Stop a link connection.

az synapse link-connection stop --name
                                --workspace-name

Examples

Stop a link connection.

az synapse link-connection stop --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

Required Parameters

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection update

Update a link connection.

az synapse link-connection update --file
                                  --name
                                  --workspace-name

Examples

Update a link connnection. Definition.json sample is { "name":"sampleLinkConnection", // please change to your link connection name "properties":{ "sourceDatabase":{ "typeProperties":{ // please change to your source database resourceId and principalId "resourceId":"/subscriptions/sampleSubscriptionId/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" } } }

az synapse link-connection update --workspace-name testsynapseworkspace \
  --name testlinkconnectionname \
  --file @"path/definition.json"

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--name -n

The link connection name.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse link-connection update-landing-zone-credential

Update landing zone credetial of a link connection.

az synapse link-connection update-landing-zone-credential --name
                                                          --sas-token
                                                          --workspace-name

Examples

Update landing zone credetial of a link connection.

az synapse link-connection update-landing-zone-credential --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --sas-token sastoken

Required Parameters

--name -n

The link connection name.

--sas-token

Value of secure string.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.