az synapse workspace

Commands

Name	Description	Type	Status
az synapse workspace activate	Activates a workspace and change it's state from pending to success state when the workspace is first being provisioned and double encryption is enabled.	Core	GA
az synapse workspace check-name	Check if a Synapse workspace name is available or not.	Core	GA
az synapse workspace create	Create a Synapse workspace.	Core	GA
az synapse workspace delete	Delete a Synapse workspace.	Core	GA
az synapse workspace firewall-rule	Manage a workspace's firewall rules.	Core	GA
az synapse workspace firewall-rule create	Create a firewall rule.	Core	GA
az synapse workspace firewall-rule delete	Delete a firewall rule.	Core	GA
az synapse workspace firewall-rule list	List all firewall rules.	Core	GA
az synapse workspace firewall-rule show	Get a firewall rule.	Core	GA
az synapse workspace firewall-rule update	Update a firewall rule.	Core	GA
az synapse workspace firewall-rule wait	Place the CLI in a waiting state until a condition of a firewall rule is met.	Core	GA
az synapse workspace key	Manage workspace's keys.	Core	GA
az synapse workspace key create	Create a workspace's key.	Core	GA
az synapse workspace key delete	Delete a workspace's key. The key at active status can't be deleted.	Core	GA
az synapse workspace key list	List keys under specified workspace.	Core	GA
az synapse workspace key show	Show a workspace's key by name.	Core	GA
az synapse workspace key wait	Place the CLI in a waiting state until a condition of a workspace key is met.	Core	GA
az synapse workspace list	List all Synapse workspaces.	Core	GA
az synapse workspace managed-identity	Manage workspace's managed-identity.	Core	GA
az synapse workspace managed-identity grant-sql-access	Grant workspace's sql-access to managed-identity.	Core	GA
az synapse workspace managed-identity revoke-sql-access	Revoke workspace's sql-access to managed-identity.	Core	GA
az synapse workspace managed-identity show-sql-access	Show workspace's sql-access state to managed-identity.	Core	GA
az synapse workspace managed-identity wait	Place the CLI in a waiting state until a condition of sql-access state to managed-identity is met.	Core	GA
az synapse workspace show	Get a Synapse workspace.	Core	GA
az synapse workspace update	Update a Synapse workspace.	Core	GA
az synapse workspace wait	Place the CLI in a waiting state until a condition of the workspace is met.	Core	GA

az synapse workspace activate --key-identifier
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]
                              [--workspace-name]

Examples

activate a workspace.

az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

Required Parameters

Optional Parameters

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 check-name --name

Examples

Check if a Synapse workspace name is available or not.

az synapse workspace check-name --name testsynapseworkspace

Required Parameters

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 create --file-system
                            --name
                            --resource-group
                            --sql-admin-login-password
                            --sql-admin-login-user
                            --storage-account
                            [--account-name]
                            [--allowed-tenant-ids]
                            [--cmk]
                            [--collaboration-branch]
                            [--enable-managed-virtual-network {false, true}]
                            [--host-name]
                            [--key-name]
                            [--last-commit-id]
                            [--location]
                            [--managed-rg-name]
                            [--no-wait]
                            [--prevent-data-exfiltration {false, true}]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--root-folder]
                            [--tags]
                            [--tenant-id]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

Examples

Create a Synapse workspace

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

Create a Synapse workspace with storage resource id

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

Create a Synapse workspace using customer-managed key

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
  --use-sami-in-encrypt True

Create a Synapse workspace connecting to azure devops

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
  --repository-name testrepo --collaboration-branch main --last-commit-id 000000

Create a Synapse workspace with managed resource group

az synapse workspace create --name testworkspace --resource-group rg \
  --managed-rg-name managedrg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

Create a Synapse workspace with user assigned managed identity

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Required Parameters

Optional Parameters

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 delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

Delete a Synapse workspace.

az synapse workspace delete --name testsynapseworkspace --resource-group rg

Optional Parameters

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 list [--resource-group]

Examples

List all Synapse workspaces under a subscription

az synapse workspace list

List all Synapse workspaces under a specific resource group

az synapse workspace list --resource-group rg

Optional Parameters

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 show [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

Examples

Get a Synapse workspace.

az synapse workspace show --name testsynapseworkspace --resource-group rg

Optional Parameters

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 update [--account-name]
                            [--allowed-tenant-ids]
                            [--collaboration-branch]
                            [--host-name]
                            [--ids]
                            [--key-name]
                            [--last-commit-id]
                            [--name]
                            [--no-wait]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--resource-group]
                            [--root-folder]
                            [--sql-admin-login-password]
                            [--subscription]
                            [--tags]
                            [--tenant-id]
                            [--uami-action {Add, Remove, Set}]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

Examples

Update a Synapse workspace

az synapse workspace update --name fromcli4 --resource-group rg \
  --tags key1=value1

Update a Synapse workspace, add user assigned managed identity

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Update a Synapse workspace, remove user assigned managed identity

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Update a Synapse workspace, rewrite user assigned managed identity

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Update a Synapse workspace, set workspace encryption uami

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False

Optional Parameters

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 wait --resource-group
                          --workspace-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

Required Parameters

Optional Parameters

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.