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 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
工作區客戶管理的金鑰顯示名稱。 您可以使用 /“az synapse workspace key list/” Cmdlet 找到所有現有的密鑰。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
請勿等候長時間執行的作業完成。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
工作區名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az synapse workspace check-name
檢查 Synapse 工作區名稱是否可用。
az synapse workspace check-name --name
範例
檢查 Synapse 工作區名稱是否可用。
az synapse workspace check-name --name testsynapseworkspace
必要參數
您要檢查的名稱。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 --key-identifier]
[--collaboration-branch]
[--enable-managed-virtual-network --enable-managed-vnet {false, true}]
[--host-name]
[--key-name]
[--last-commit-id]
[--location]
[--managed-rg-name]
[--no-wait]
[--prevent-data-exfiltration --prevent-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 帳戶名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
允許輸出數據流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 在 PowerShell 中使用 “” 或 '' ('“”' 來停用所有允許的租使用者識別碼。
客戶管理的金鑰,用來加密工作區中待用的所有數據。 密鑰標識碼的格式應為:https://{keyvaultname}.vault.azure.net/keys/{keyname}。
您將與其他人共同作業的分支名稱,以及您將從中發佈的位置。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
旗標會指出是否啟用受控虛擬網路。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
如果使用 github Enterprise Server,請提供伺服器 URL。 請勿搭配 GitHub Enterprise Cloud 使用此選項。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
工作區客戶管理的金鑰顯示名稱。 您可以使用 “az synapse workspace key list” Cmdlet 找到所有現有的密鑰。
| 屬性 | 值 |
|---|---|
| 預設值: | default |
最後一個認可標識碼。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
Location. 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location>來設定預設位置。
工作區受控資源群組。 資源組名會唯一識別使用者 subscriptionId 內的資源群組。
請勿等候長時間執行的作業完成。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
旗標會指出是否啟用數據外流。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
您要連線的項目名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
您要連接存放庫的名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
存放庫組態類型。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
| 接受的值: | AzureDevOpsGit, GitHub |
匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
| 預設值: | / |
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
用來連線 Azure devops 的租用戶標識碼。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
工作區的使用者指派受控識別標識碼清單。
使用者指派的身分識別資源標識符,用於工作區加密。
是否在工作區加密中使用系統指派的身分識別。 如果使用 uami,請設定 True。如果沒有,請設定 False。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
工作區名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
請勿等候長時間執行的作業完成。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
請勿提示確認。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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>來設定預設群組。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
工作區名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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 帳戶名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
允許輸出數據流量的已核准 Azure AD 租使用者。 預設會包含目前使用者的 Azure AD 租使用者。 在 PowerShell 中使用 “” 或 '' ('“”' 來停用所有允許的租使用者識別碼。
您將與其他人共同作業的分支名稱,以及您將從中發佈的位置。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
如果使用 github Enterprise Server,請提供伺服器 URL。 請勿搭配 GitHub Enterprise Cloud 使用此選項。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
工作區客戶管理的金鑰顯示名稱。 您可以使用 “az synapse workspace key list” Cmdlet 找到所有現有的密鑰。
最後一個認可標識碼。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
工作區名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
請勿等候長時間執行的作業完成。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
您要連線的項目名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
您要連接存放庫的名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
存放庫組態類型。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
| 接受的值: | AzureDevOpsGit, GitHub |
資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
匯入 Azure synapse JSON 資源位置的資料夾名稱。 預設值為 /。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
sql 系統管理員登入密碼。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
| 屬性 | 值 |
|---|---|
| 參數群組: | Resource Id Arguments |
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
用來連線 Azure devops 的租用戶標識碼。
| 屬性 | 值 |
|---|---|
| 參數群組: | Git Configuration Arguments |
當您為工作區新增/移除/設定使用者指派的受控識別時,必須指定動作。支持的動作包括:Add、Remove、Set.Add 表示為工作區新增使用者指派的受控識別、移除從工作區移除使用者指派的受控識別,當您想要新增和移除使用者指派的受控識別時,可以使用 Set,同時由指定的受控識別涵蓋目前的身分識別。
| 屬性 | 值 |
|---|---|
| 接受的值: | Add, Remove, Set |
工作區的使用者指派受控識別標識碼清單。
使用者指派的身分識別資源標識符,用於工作區加密。
是否在工作區加密中使用系統指派的身分識別。 如果使用 uami,請設定 True。如果沒有,請設定 False。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
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' 建立。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | False |
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
等到刪除為止。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | False |
等候資源存在。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | False |
輪詢間隔以秒為單位。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | 30 |
以秒為單位的等候上限。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | 3600 |
等到 provisioningState 更新為 'Succeeded'。
| 屬性 | 值 |
|---|---|
| 參數群組: | Wait Condition Arguments |
| 預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |