az synapse workspace key

參考

管理工作區的金鑰。

命令

名稱	Description	類型	狀態
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 key create

編輯

建立工作區的金鑰。

az synapse workspace key create --key-identifier
                                --name
                                --resource-group
                                --workspace-name
                                [--no-wait]

範例

建立工作區的金鑰。

az synapse workspace key create --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}。

--name -n

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

--resource-group -g

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

--workspace-name

工作區名稱。

選擇性參數

--no-wait

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

預設值: 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 key delete

編輯

刪除工作區的金鑰。無法刪除作用中狀態的索引鍵。

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

範例

刪除工作區的金鑰。

az synapse workspace key delete --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

選擇性參數

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

工作區名稱。

--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 key list

編輯

列出指定工作區下的索引鍵。

az synapse workspace key list --resource-group
                              --workspace-name

範例

列出指定工作區下的索引鍵。

az synapse workspace key list --workspace-name testsynapseworkspace --resource-group rg

必要參數

--resource-group -g

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

--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 key show

編輯

依名稱顯示工作區的金鑰。

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

範例

顯示工作區的金鑰。

az synapse workspace key show --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

選擇性參數

--ids

--name -n

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

--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 key wait

編輯

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

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

必要參數

--key-name

工作區金鑰的名稱。

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

--interval

輪詢間隔以秒為單位。

預設值: 30

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

--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 key

命令

az synapse workspace key create

範例

必要參數

選擇性參數

az synapse workspace key delete

範例

選擇性參數

az synapse workspace key list

範例

必要參數

az synapse workspace key show

範例

選擇性參數

az synapse workspace key wait

必要參數

選擇性參數

其他資源