Share via

az synapse workspace-package

  • Reference

Manage Synapse's workspace packages.

Commands

Name Description Type Status
az synapse workspace-package delete

Delete a workspace package.

 Core GA
az synapse workspace-package list

List workspace packages.

 Core GA
az synapse workspace-package show

Get a workspace package.

 Core GA
az synapse workspace-package upload

Upload a local workspace package file to an Azure Synapse workspace.

 Core GA
az synapse workspace-package upload-batch

Upload workspace package files from a local directory to an Azure Synapse workspace.

 Core GA

az synapse workspace-package delete

Edit

Delete a workspace package.

az synapse workspace-package delete --name
                                    --workspace-name
                                    [--no-wait]
                                    [--yes]

Examples

Delete a workspace package.

az synapse workspace-package delete --workspace-name testsynapseworkspace \
  --name testpackage.jar

Required Parameters

--name --package --package-name -n

The workspace package 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 workspace-package list

Edit

List workspace packages.

az synapse workspace-package list --workspace-name

Examples

List workspace packages.

az synapse workspace-package 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 workspace-package show

Edit

Get a workspace package.

az synapse workspace-package show --name
                                  --workspace-name

Examples

Get a workspace package.

az synapse workspace-package show --workspace-name testsynapseworkspace \
  --name testpackage.jar

Required Parameters

--name --package --package-name -n

The workspace package 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 workspace-package upload

Edit

Upload a local workspace package file to an Azure Synapse workspace.

az synapse workspace-package upload --file
                                    --workspace-name
                                    [--no-progress]

Examples

Upload a local workspace package file to an Azure Synapse workspace.

az synapse workspace-package upload --workspace-name testsynapseworkspace \
  --package C:/package.jar

Required Parameters

--file --package -f

Specifies a local file path for a file to upload as workspace package.

--workspace-name

The workspace name.

Optional Parameters

--no-progress

Include this flag to disable progress reporting for the command.

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 workspace-package upload-batch

Edit

Upload workspace package files from a local directory to an Azure Synapse workspace.

az synapse workspace-package upload-batch --source
                                          --workspace-name
                                          [--no-progress]

Examples

Upload workspace package files from a local directory to an Azure Synapse workspace.

az synapse workspace-package upload-batch --workspace-name testsynapseworkspace \
  --source C:/package

Required Parameters

--source -s

The directory where the files to be uploaded are located.

--workspace-name

The workspace name.

Optional Parameters

--no-progress

Include this flag to disable progress reporting for the command.

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.