az synapse workspace

Manage Synapse workspaces.

Commands

az synapse workspace check-name

Check if a Synapse workspace name is available or not.

az synapse workspace create

Create a Synapse workspace.

az synapse workspace delete

Delete a Synapse workspace.

az synapse workspace firewall-rule

Manage a workspace's firewall rules.

az synapse workspace firewall-rule create

Create a firewall rule.

az synapse workspace firewall-rule delete

Delete a firewall rule.

az synapse workspace firewall-rule list

List all firewall rules.

az synapse workspace firewall-rule show

Get a firewall rule.

az synapse workspace firewall-rule wait

Place the CLI in a waiting state until a condition of a firewall rule is met.

az synapse workspace list

List all Synapse workspaces.

az synapse workspace show

Get a Synapse workspace.

az synapse workspace update

Update a Synapse workspace.

az synapse workspace wait

Place the CLI in a waiting state until a condition of the workspace is met.

az synapse workspace check-name

Check if a Synapse workspace name is available or not.

az synapse workspace check-name --name
                                [--subscription]

Examples

Check if a Synapse workspace name is available or not.

az synapse workspace check-name --name testsynapseworkspace

Required Parameters

--name -n

The name you wanted to check.

Optional Parameters

--subscription

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

az synapse workspace create

Create a Synapse workspace.

az synapse workspace create --file-system
                            --location
                            --name
                            --resource-group
                            --sql-admin-login-password
                            --sql-admin-login-user
                            --storage-account
                            [--no-wait]
                            [--subscription]
                            [--tags]

Examples

Create a Synapse workspace

az synapse workspace create --name fromcli4 --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 fromcli4 --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"

Required Parameters

--file-system

The file system of the data lake storage account.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The workspace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sql-admin-login-password -p

The sql administrator login password.

--sql-admin-login-user -u

The sql administrator login user name.

--storage-account

The data lake storage account name or resource id.

Optional Parameters

--no-wait

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az synapse workspace delete

Delete a Synapse workspace.

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workspace name.

--no-wait

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--yes -y

Do not prompt for confirmation.

az synapse workspace list

List all Synapse workspaces.

az synapse workspace list [--query-examples]
                          [--resource-group]
                          [--subscription]

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

az synapse workspace show

Get a Synapse workspace.

az synapse workspace show [--ids]
                          [--name]
                          [--query-examples]
                          [--resource-group]
                          [--subscription]

Examples

Get a Synapse workspace.

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workspace name.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

az synapse workspace update

Update a Synapse workspace.

az synapse workspace update [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--sql-admin-login-password]
                            [--subscription]
                            [--tags]

Examples

Update a Synapse workspace

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The workspace name.

--no-wait

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sql-admin-login-password -p

The sql administrator login password.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az synapse workspace wait

Place the CLI in a waiting state until a condition of the workspace is met.

az synapse workspace wait --resource-group
                          --workspace-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--subscription]
                          [--timeout]
                          [--updated]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.