az keyvault security-domain

管理安全性網域作業。

命令

名稱	Description	類型	狀態
az keyvault security-domain download	從 HSM 下載安全性網域檔案。	核心	GA
az keyvault security-domain init-recovery	擷取 HSM 的交換金鑰。	核心	GA
az keyvault security-domain restore-blob	啟用 將安全性網域檔案解密和加密為 Blob。 可以在離線環境中執行，再使用安全性網域上傳將檔案上傳至 HSM。	核心	GA
az keyvault security-domain upload	開始還原 HSM。	核心	GA
az keyvault security-domain wait	將 CLI 置於等候狀態，直到 HSM 安全性網域作業完成為止。	核心	GA

az keyvault security-domain download

從 HSM 下載安全性網域檔案。

az keyvault security-domain download --sd-quorum
                                     --sd-wrapping-keys
                                     --security-domain-file
                                     [--hsm-name]
                                     [--id]
                                     [--no-wait]

範例

安全性網域下載 （N=3， M=2）。

az keyvault security-domain download --hsm-name MyHSM --security-domain-file "{SD_FILE_NAME}" --sd-quorum 2 --sd-wrapping-keys "{PEM_PUBLIC_KEY1_FILE_NAME}" "{PEM_PUBLIC_KEY2_FILE_NAME}" "{PEM_PUBLIC_KEY3_FILE_NAME}"

必要參數

--sd-quorum

解密安全性網域以進行復原所需的最小共用數目。

--sd-wrapping-keys

包含公開金鑰之 PEM 檔案的空間分隔檔案路徑。

--security-domain-file

儲存此命令所傳回 JSON Blob 之檔案的路徑。

選擇性參數

--hsm-name

HSM 的名稱。 如果指定了 --id，可以省略。

--id

HSM 的完整 URI。

--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 keyvault security-domain init-recovery

擷取 HSM 的交換金鑰。

az keyvault security-domain init-recovery --sd-exchange-key
                                          [--hsm-name]
                                          [--id]

範例

擷取交換金鑰並加以儲存。

az keyvault security-domain init-recovery --hsm-name MyHSM --sd-exchange-key "{PATH_TO_RESTORE}"

必要參數

--sd-exchange-key

用來儲存匯出金鑰的本機檔案路徑。

選擇性參數

--hsm-name

HSM 的名稱。 如果指定了 --id，可以省略。

--id

HSM 的完整 URI。

全域參數

--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 keyvault security-domain restore-blob

啟用 將安全性網域檔案解密和加密為 Blob。 可以在離線環境中執行，再使用安全性網域上傳將檔案上傳至 HSM。

az keyvault security-domain restore-blob --sd-exchange-key
                                         --sd-file
                                         --sd-file-restore-blob
                                         --sd-wrapping-keys
                                         [--passwords]

範例

安全性網域還原 Blob。

az keyvault security-domain restore-blob --sd-file "{SD_TRANSFER_FILE}" --sd-exchange-key "{PEM_FILE_NAME}" --sd-wrapping-keys "{PEM_PRIVATE_KEY1_FILE_NAME}" "{PEM_PRIVATE_KEY2_FILE_NAME}" --sd-file-restore-blob "{SD_TRANSFER_FILE_RESTORE_BLOB}"

必要參數

--sd-exchange-key

安全性網域的交換金鑰。

--sd-file

此檔案包含使用在 security-domain init-recovery 命令中下載之 SD Exchange 檔案加密的安全性網域。

--sd-file-restore-blob

用來儲存使用交換金鑰加密之安全性網域的本機檔案路徑。

--sd-wrapping-keys

包含私密金鑰之 PEM 檔案的空間分隔檔案路徑。

選擇性參數

--passwords

--sd-wrapping-keys 的空間分隔密碼清單。 CLI 會依序比對它們。 如果您的金鑰沒有密碼保護，可以省略。

全域參數

--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 keyvault security-domain upload

開始還原 HSM。

az keyvault security-domain upload --sd-file
                                   [--hsm-name]
                                   [--id]
                                   [--no-wait]
                                   [--passwords]
                                   [--restore-blob]
                                   [--sd-exchange-key]
                                   [--sd-wrapping-keys]

範例

安全性網域上傳 （M=2）。

az keyvault security-domain upload --hsm-name MyHSM --sd-file "{SD_TRANSFER_FILE}" --sd-exchange-key "{PEM_FILE_NAME}" --sd-wrapping-keys "{PEM_PRIVATE_KEY1_FILE_NAME}" "{PEM_PRIVATE_KEY2_FILE_NAME}"

安全性網域上傳，其中已使用 keyvault security-domain restore-blob 命令還原sd_file

az keyvault security-domain upload --hsm-name MyHSM --sd-file "{SD_TRANSFER_FILE}" --restore-blob

必要參數

--sd-file

此檔案包含使用在 security-domain init-recovery 命令中下載之 SD Exchange 檔案加密的安全性網域。

選擇性參數

--hsm-name

HSM 的名稱。 如果指定了 --id，可以省略。

--id

HSM 的完整 URI。

--no-wait

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

預設值: False

--passwords

--sd-wrapping-keys 的空間分隔密碼清單。 CLI 會依序比對它們。 如果您的金鑰沒有密碼保護，可以省略。

--restore-blob

是否已還原 Blob 的指標。

預設值: False

--sd-exchange-key

安全性網域的交換金鑰。

--sd-wrapping-keys

包含私密金鑰之 PEM 檔案的空間分隔檔案路徑。

全域參數

--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 keyvault security-domain wait

將 CLI 置於等候狀態，直到 HSM 安全性網域作業完成為止。

az keyvault security-domain wait [--hsm-name]
                                 [--id]
                                 [--target-operation {download, restore_blob, upload}]

範例

暫停 CLI，直到安全性網域作業完成為止。

az keyvault security-domain wait --hsm-name MyHSM

選擇性參數

--hsm-name

HSM 的名稱。 如果指定了 --id，可以省略。

--id

HSM 的完整 URI。

--target-operation

需要等候的目標作業。

接受的值: download, restore_blob, upload

預設值: upload

全域參數

--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 來取得完整偵錯記錄。