Share via

az synapse linked-service

  • Reference

Manage Synapse's linked services.

Commands

Name Description Type Status
az synapse linked-service create

Create a linked service.

 Core GA
az synapse linked-service delete

Delete a linked service.

 Core GA
az synapse linked-service list

List linked services.

 Core GA
az synapse linked-service set

Update an exist linked service.

 Core Deprecated
az synapse linked-service show

Get a linked service.

 Core GA
az synapse linked-service update

Update an exist linked service.

 Core GA

az synapse linked-service create

Edit

Create a linked service.

az synapse linked-service create --file
                                 --name
                                 --workspace-name
                                 [--no-wait]

Examples

Create a linked service. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse linked-service create --workspace-name testsynapseworkspace \
  --name testlinkedservice --file @"path/linkedservice.json"

Required Parameters

--file

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

--name -n

The linked service name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
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 linked-service delete

Edit

Delete a linked service.

az synapse linked-service delete --name
                                 --workspace-name
                                 [--no-wait]
                                 [--yes]

Examples

Delete a linked service.

az synapse linked-service delete --workspace-name testsynapseworkspace \
  --name testlinkedservice

Required Parameters

--name -n

The linked service name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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 linked-service list

Edit

List linked services.

az synapse linked-service list --workspace-name

Examples

List linked services.

az synapse linked-service 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 linked-service set

Edit
Deprecated

This command has been deprecated and will be removed in a future release. Use 'update' instead.

Update an exist linked service.

az synapse linked-service set --file
                              --name
                              --workspace-name
                              [--no-wait]

Examples

Update an exist linked service. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse linked-service set --workspace-name testsynapseworkspace \
  --name testlinkedservice --file @"path/linkedservice.json"

Required Parameters

--file

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

--name -n

The linked service name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
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 linked-service show

Edit

Get a linked service.

az synapse linked-service show --name
                               --workspace-name

Examples

Get a linked service.

az synapse linked-service show --workspace-name testsynapseworkspace \
  --name testlinkedservice

Required Parameters

--name -n

The linked service 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 linked-service update

Edit

Update an exist linked service.

az synapse linked-service update --file
                                 --name
                                 --workspace-name
                                 [--no-wait]

Examples

Update an exist linked service. Pay attention to add "@" at the front of the file path as the best practice for complex arguments like JSON string.

az synapse linked-service update --workspace-name testsynapseworkspace \
  --name testlinkedservice --file @"path/linkedservice.json"

Required Parameters

--file

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

--name -n

The linked service name.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
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.