az synapse workspace
管理 Synapse 工作區。
命令
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}必要參數
工作區加密金鑰金鑰保存庫 URL。 格式應為： HTTPs://{keyvaultname}.vault.azure.net/keys/{keyname}。
選擇性參數
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
工作區客戶管理的金鑰顯示名稱。 您可以使用 /「az synapse workspace key list/」 Cmdlet 找到所有現有的金鑰。
請勿等候長時間執行的作業完成。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
工作區名稱。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az synapse workspace check-name
檢查 Synapse 工作區名稱是否可用。
az synapse workspace check-name --name範例
檢查 Synapse 工作區名稱是否可用。
az synapse workspace check-name --name testsynapseworkspace必要參數
您想要檢查的名稱。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --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}"必要參數
Data Lake Storage 帳戶的檔案系統。
工作區名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
sql 系統管理員登入密碼。
sql 系統管理員登入使用者名稱。
Data Lake Storage 帳戶名稱或資源識別碼。
選擇性參數
用於存放庫或 Azure devops 組織名稱的 GitHub 帳戶名稱。
允許輸出資料流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 使用 （'' in PowerShell） 來停用所有允許的租使用者識別碼。
客戶管理的金鑰，用來加密工作區中待用的所有資料。 金鑰識別碼的格式應為：HTTPs://{keyvaultname}.vault.azure.net/keys/{keyname}。
您將與其他人共同作業的分支名稱，以及您將從中發佈的位置。
旗標會指出是否啟用受控虛擬網路。
如果使用 github Enterprise Server，請提供像是不要搭配 GitHub Enterprise Cloud 使用此選項的 https://github.mydomain.com.Do 伺服器 URL。
工作區客戶管理的金鑰顯示名稱。 您可以使用 「az synapse workspace key list」 Cmdlet 找到所有現有的金鑰。
最後一個認可識別碼。
位置。 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。
工作區受控資源群組。 資源組名會唯一識別使用者 subscriptionId 內的資源群組。
請勿等候長時間執行的作業完成。
旗標會指出是否啟用資料外流。
您要連線的專案名稱。
您要連接之存放庫的名稱。
存放庫組態類型。
匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。
以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
用來連線 Azure devops 的租使用者識別碼。
工作區的使用者指派受控識別識別碼清單。
使用者指派的身分識別資源識別碼，用於工作區加密。
是否在工作區加密中使用系統指派的身分識別。 如果使用 uami，請設定 True。如果沒有，請設定 False。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --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 或其他「資源識別碼」引數。
工作區名稱。
請勿等候長時間執行的作業完成。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
不提示確認。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --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選擇性參數
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --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 或其他「資源識別碼」引數。
工作區名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --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選擇性參數
用於存放庫或 Azure devops 組織名稱的 GitHub 帳戶名稱。
允許輸出資料流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 使用 （'' in PowerShell） 來停用所有允許的租使用者識別碼。
您將與其他人共同作業的分支名稱，以及您將從中發佈的位置。
如果使用 github Enterprise Server，請提供像是不要搭配 GitHub Enterprise Cloud 使用此選項的 https://github.mydomain.com.Do 伺服器 URL。
一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源識別碼」引數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」引數。
工作區客戶管理的金鑰顯示名稱。 您可以使用 「az synapse workspace key list」 Cmdlet 找到所有現有的金鑰。
最後一個認可識別碼。
工作區名稱。
請勿等候長時間執行的作業完成。
您要連線的專案名稱。
您要連接之存放庫的名稱。
存放庫組態類型。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。
sql 系統管理員登入密碼。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
用來連線 Azure devops 的租使用者識別碼。
當您為工作區新增/移除/設定使用者指派的受控識別時，必須指定動作。支援的動作包括：Add、Remove、Set.Add 表示為工作區新增使用者指派的受控識別、移除從工作區移除使用者指派的受控識別，當您想要新增和移除使用者指派的受控識別時，可以使用 Set，同時由指定的受控識別涵蓋目前的身分識別。
工作區的使用者指派受控識別識別碼清單。
使用者指派的身分識別資源識別碼，用於工作區加密。
是否在工作區加密中使用系統指派的身分識別。 如果使用 uami，請設定 True。如果沒有，請設定 False。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az synapse workspace wait
將 CLI 置於等候狀態，直到符合工作區的條件為止。
az synapse workspace wait --resource-group
--workspace-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]必要參數
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。
工作區的名稱。
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。
等到刪除為止。
等候資源存在。
輪詢間隔以秒為單位。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應