az synapse workspace

管理 Synapse 工作區。

命令

名稱	Description	類型	狀態
az synapse workspace activate	啟動工作區，並在第一次布建工作區並啟用雙重加密時，將其狀態從擱置變更為成功狀態。	核心	GA
az synapse workspace check-name	檢查 Synapse 工作區名稱是否可用。	核心	GA
az synapse workspace create	建立 Synapse 工作區。	核心	GA
az synapse workspace delete	刪除 Synapse 工作區。	核心	GA
az synapse workspace firewall-rule	管理工作區的防火牆規則。	核心	GA
az synapse workspace firewall-rule create	建立防火牆規則。	核心	GA
az synapse workspace firewall-rule delete	刪除防火牆規則。	核心	GA
az synapse workspace firewall-rule list	列出所有防火牆規則。	核心	GA
az synapse workspace firewall-rule show	取得防火牆規則。	核心	GA
az synapse workspace firewall-rule update	更新防火牆規則。	核心	GA
az synapse workspace firewall-rule wait	將 CLI 置於等候狀態，直到符合防火牆規則的條件為止。	核心	GA
az synapse workspace key	管理工作區的金鑰。	核心	GA
az synapse workspace key create	建立工作區的金鑰。	核心	GA
az synapse workspace key delete	刪除工作區的金鑰。 無法刪除作用中狀態的索引鍵。	核心	GA
az synapse workspace key list	列出指定工作區下的索引鍵。	核心	GA
az synapse workspace key show	依名稱顯示工作區的金鑰。	核心	GA
az synapse workspace key wait	將 CLI 置於等候狀態，直到符合工作區金鑰的條件為止。	核心	GA
az synapse workspace list	列出所有 Synapse 工作區。	核心	GA
az synapse workspace managed-identity	管理工作區的受控識別。	核心	GA
az synapse workspace managed-identity grant-sql-access	將工作區的 sql-access 授與受控識別。	核心	GA
az synapse workspace managed-identity revoke-sql-access	撤銷工作區對受控識別的 sql 存取權。	核心	GA
az synapse workspace managed-identity show-sql-access	向受控識別顯示工作區的 sql 存取狀態。	核心	GA
az synapse workspace managed-identity wait	將 CLI 置於等候狀態，直到符合受控識別的 sql 存取狀態為止。	核心	GA
az synapse workspace show	取得 Synapse 工作區。	核心	GA
az synapse workspace update	更新 Synapse 工作區。	核心	GA
az synapse workspace wait	將 CLI 置於等候狀態，直到符合工作區的條件為止。	核心	GA

az synapse workspace activate

啟動工作區，並在第一次布建工作區並啟用雙重加密時，將其狀態從擱置變更為成功狀態。

建立 Azure Synapse Analytics 工作區時，您可以選擇使用客戶管理的金鑰來加密工作區中待用的所有資料，以便為工作區提供雙重加密。您可能需要先設定加密環境，例如建立已啟用清除保護的金鑰保存庫，並指定金鑰保存庫的存取原則。 然後使用此 Cmdlet 來啟用新的 Azure Synapse Analytics 工作區，該工作區會使用客戶管理的金鑰來啟用雙重加密。

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

範例

啟動工作區。

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

必要參數

--key-identifier

工作區加密金鑰金鑰保存庫 URL。 格式應為： HTTPs://{keyvaultname}.vault.azure.net/keys/{keyname}。

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

工作區客戶管理的金鑰顯示名稱。 您可以使用 /「az synapse workspace key list/」 Cmdlet 找到所有現有的金鑰。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--workspace-name

工作區名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace check-name

檢查 Synapse 工作區名稱是否可用。

az synapse workspace check-name --name

範例

檢查 Synapse 工作區名稱是否可用。

az synapse workspace check-name --name testsynapseworkspace

必要參數

--name -n

您想要檢查的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace create

建立 Synapse 工作區。

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]

範例

建立 Synapse 工作區

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"

使用儲存體資源識別碼建立 Synapse 工作區

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"

使用客戶管理的金鑰建立 Synapse 工作區

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

建立連線至 Azure devops 的 Synapse 工作區

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

使用受控資源群組建立 Synapse 工作區

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"

使用使用者指派的受控識別建立 Synapse 工作區

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}"

必要參數

--file-system

Data Lake Storage 帳戶的檔案系統。

--name -n

工作區名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--sql-admin-login-password -p

sql 系統管理員登入密碼。

--sql-admin-login-user -u

sql 系統管理員登入使用者名稱。

--storage-account

Data Lake Storage 帳戶名稱或資源識別碼。

選擇性參數

--account-name

用於存放庫或 Azure devops 組織名稱的 GitHub 帳戶名稱。

--allowed-tenant-ids

允許輸出資料流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 使用 （'' in PowerShell） 來停用所有允許的租使用者識別碼。

--cmk --key-identifier

客戶管理的金鑰，用來加密工作區中待用的所有資料。 金鑰識別碼的格式應為：HTTPs://{keyvaultname}.vault.azure.net/keys/{keyname}。

--collaboration-branch

您將與其他人共同作業的分支名稱，以及您將從中發佈的位置。

--enable-managed-virtual-network --enable-managed-vnet

旗標會指出是否啟用受控虛擬網路。

接受的值: false, true

--host-name

如果使用 github Enterprise Server，請提供像是不要搭配 GitHub Enterprise Cloud 使用此選項的 https://github.mydomain.com.Do 伺服器 URL。

--key-name

工作區客戶管理的金鑰顯示名稱。 您可以使用 「az synapse workspace key list」 Cmdlet 找到所有現有的金鑰。

預設值: default

--last-commit-id

最後一個認可識別碼。

--location -l

位置。​​ 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。

--managed-rg-name

工作區受控資源群組。 資源組名會唯一識別使用者 subscriptionId 內的資源群組。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--prevent-data-exfiltration --prevent-exfiltration

旗標會指出是否啟用資料外流。

接受的值: false, true

--project-name

您要連線的專案名稱。

--repository-name

您要連接之存放庫的名稱。

--repository-type

存放庫組態類型。

接受的值: AzureDevOpsGit, GitHub

--root-folder

匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。

預設值: /

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。

--tenant-id

用來連線 Azure devops 的租使用者識別碼。

--uami-id

工作區的使用者指派受控識別識別碼清單。

--uami-id-in-encrypt

使用者指派的身分識別資源識別碼，用於工作區加密。

--use-sami-in-encrypt

是否在工作區加密中使用系統指派的身分識別。 如果使用 uami，請設定 True。如果沒有，請設定 False。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace delete

刪除 Synapse 工作區。

az synapse workspace delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

範例

刪除 Synapse 工作區。

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

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

工作區名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace list

列出所有 Synapse 工作區。

az synapse workspace list [--resource-group]

範例

列出訂用帳戶下的所有 Synapse 工作區

az synapse workspace list

列出特定資源群組下的所有 Synapse 工作區

az synapse workspace list --resource-group rg

選擇性參數

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace show

取得 Synapse 工作區。

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

範例

取得 Synapse 工作區。

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

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

工作區名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace update

更新 Synapse 工作區。

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]

範例

更新 Synapse 工作區

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

更新 Synapse 工作區，新增使用者指派的受控識別

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

更新 Synapse 工作區，移除使用者指派的受控識別

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

更新 Synapse 工作區，重寫使用者指派的受控識別

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

更新 Synapse 工作區，設定工作區加密 uami

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

選擇性參數

--account-name

用於存放庫或 Azure devops 組織名稱的 GitHub 帳戶名稱。

--allowed-tenant-ids

允許輸出資料流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 使用 （'' in PowerShell） 來停用所有允許的租使用者識別碼。

--collaboration-branch

您將與其他人共同作業的分支名稱，以及您將從中發佈的位置。

--host-name

如果使用 github Enterprise Server，請提供像是不要搭配 GitHub Enterprise Cloud 使用此選項的 https://github.mydomain.com.Do 伺服器 URL。

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。

--key-name

工作區客戶管理的金鑰顯示名稱。 您可以使用 「az synapse workspace key list」 Cmdlet 找到所有現有的金鑰。

--last-commit-id

最後一個認可識別碼。

--name -n

工作區名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--project-name

您要連線的專案名稱。

--repository-name

您要連接之存放庫的名稱。

--repository-type

存放庫組態類型。

接受的值: AzureDevOpsGit, GitHub

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--root-folder

匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。

--sql-admin-login-password -p

sql 系統管理員登入密碼。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。

--tenant-id

用來連線 Azure devops 的租使用者識別碼。

--uami-action

當您為工作區新增/移除/設定使用者指派的受控識別時，必須指定動作。支援的動作包括：Add、Remove、Set.Add 表示為工作區新增使用者指派的受控識別、移除從工作區移除使用者指派的受控識別，當您想要新增和移除使用者指派的受控識別時，可以使用 Set，同時由指定的受控識別涵蓋目前的身分識別。

接受的值: Add, Remove, Set

--uami-id

工作區的使用者指派受控識別識別碼清單。

--uami-id-in-encrypt

使用者指派的身分識別資源識別碼，用於工作區加密。

--use-sami-in-encrypt

是否在工作區加密中使用系統指派的身分識別。 如果使用 uami，請設定 True。如果沒有，請設定 False。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az synapse workspace wait

將 CLI 置於等候狀態，直到符合工作區的條件為止。

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

必要參數

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

--workspace-name

工作區的名稱。

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。