Azure Key Vault REST API 參考

使用金鑰保存庫來保護和管理雲端應用程式和服務所使用的密碼編譯金鑰、憑證和秘密。

金鑰保存庫作業

作業	描述
檢查名稱可用性	檢查保存庫名稱是否有效，且尚未使用中。
建立或更新	在指定的訂用帳戶中建立或更新金鑰保存庫。
更新存取原則	更新指定訂用帳戶中金鑰保存庫中的存取原則。
Get	取得指定的 Azure 金鑰保存庫。
清單	清單作業會取得與訂用帳戶相關聯的保存庫相關資訊。
依資源群組列示	清單作業會取得與訂用帳戶相關聯之保存庫和指定資源群組內之保存庫的相關資訊。
依訂用帳戶列出	清單作業會取得與訂用帳戶相關聯的保存庫相關資訊。
更新	更新指定訂用帳戶中的金鑰保存庫。
刪除	刪除指定的 Azure 金鑰保存庫。
取得已刪除	取得已刪除的 Azure 金鑰保存庫。
清單已刪除	取得訂用帳戶中已刪除保存庫的相關資訊。
清除	永久刪除指定的保存庫。

私人連結作業

作業	描述
依保存庫列出	取得金鑰保存庫支援的私人連結資源。

私人端點連線作業

作業	描述
Get	取得與金鑰保存庫相關聯的指定私人端點連線。
依資源列出	清單作業會取得與保存庫相關聯的私人端點連線相關資訊。
把	更新與金鑰保存庫相關聯的指定私人端點連線。
刪除	刪除與金鑰保存庫相關聯的指定私人端點連線。

受控 HSM 作業

作業	描述
建立或更新	在指定的訂用帳戶中建立或更新受控 HSM 集區。
Get	取得指定的受控 HSM 集區。
依資源群組列示	清單作業會取得與訂用帳戶和指定資源群組內相關聯之受控 HSM 集區的相關資訊。
依訂用帳戶列出	清單作業會取得與訂用帳戶相關聯的受控 HSM 集區相關資訊。
更新	更新指定訂用帳戶中的受控 HSM 集區。
取得已刪除	取得指定的已刪除受控 HSM。
清單已刪除	清單作業會取得與訂用帳戶相關聯的已刪除受控 HSM 相關資訊。
刪除	刪除指定的受控 HSM 集區。
清除已刪除	永久刪除指定的受控 HSM。

私人連結作業

作業	描述
依 MHSM 資源列出	取得受控 HSM 集區支援的私人連結資源。

私人端點連線作業

作業	描述
Get	取得與受控 HSM 集區相關聯的指定私人端點連線。
依資源列出	清單作業會取得與受控 HSM 集區相關聯的私人端點連線相關資訊。
把	更新與受控 HSM 集區相關聯的指定私人端點連線。
刪除	刪除與受控 HSM 集區相關聯的指定私人端點連線。

HSM 安全性網域作業

作業	描述
下載	從受控 HSM 擷取安全性網域。 呼叫此端點可用來啟用布建的受控 HSM 資源。
下載擱置中	擷取安全性網域下載作業狀態。
上傳	還原所提供的安全性網域。
上傳擱置中	取得安全性網域上傳作業狀態。

受控 HSM 設定作業

作業	描述
取得設定	取得指定的帳號設定物件。 擷取指定之設定名稱的設定物件。
取得設定	列出帳戶設定。 擷取可設定的所有可用帳戶設定清單。
更新設定	更新金鑰保存庫帳戶設定、儲存金鑰保存庫帳戶，然後將設定名稱和值傳回給用戶端。 要更新的集區設定描述

角色型存取控制作業

角色指派作業

作業	描述
Get	取得指定的角色指派。
清單	取得範圍的角色指派。
建立	建立角色指派。
刪除	刪除角色指派。

角色定義作業

作業	描述
Get	取得指定的角色定義。
清單	取得範圍和更新版本適用的所有角色定義。
建立或更新	建立或更新自訂角色定義。
刪除	刪除自訂角色定義。

備份/還原作業

作業	描述
完整備份	使用使用者提供的 SAS 權杖建立完整備份至 Azure Blob 儲存體容器。 只有受控 HSM 服務才支援這項作業。
備份狀態	傳回完整備份作業的狀態。
完整還原	使用指向先前儲存的 Azure Blob 儲存體備份檔案夾的 SAS 權杖還原所有金鑰資料。
選擇性還原	使用使用者提供的 SAS 權杖，還原指定金鑰的所有金鑰版本，指向先前儲存的 Azure Blob 儲存體備份檔案夾。
還原狀態	傳回還原作業的狀態。

金鑰作業 (金鑰保存庫/受控 HSM)

作業	描述
取得金鑰	取得預存金鑰的公用部分。
取得金鑰	列出指定保存庫中的金鑰。
取得金鑰版本	擷取具有相同金鑰名稱的個別金鑰版本清單。
建立金鑰	建立新的金鑰、加以儲存，然後將金鑰參數和屬性傳回至用戶端。
匯入金鑰	匯出外部建立的金鑰、加以儲存，然後將金鑰參數和屬性傳回至用戶端。
更新金鑰	更新金鑰作業會變更預存金鑰的指定屬性，並可套用至儲存在 Azure 金鑰保存庫 中的任何金鑰類型和金鑰版本。
刪除金鑰	從 Azure 金鑰保存庫 中的儲存體中刪除任何類型的金鑰。
取得已刪除的金鑰	取得已刪除金鑰的公用部分。
取得已刪除的金鑰	列出指定保存庫中已刪除的金鑰。
清除已刪除的金鑰	永久刪除指定的索引鍵。
復原已刪除的金鑰	將已刪除的金鑰復原至其最新版本。
備份金鑰	要求將指定金鑰的備份下載至用戶端。
還原金鑰	將備份的金鑰還原至保存庫。
發行金鑰	釋放金鑰。 發行金鑰作業適用于所有金鑰類型。 目標金鑰必須標示為可匯出。 此作業需要金鑰/發行許可權。
輪替金鑰	建立新的金鑰版本、儲存金鑰，然後將金鑰參數、屬性和原則傳回給用戶端。 此作業會根據金鑰原則輪替金鑰。 它需要金鑰/輪替許可權。
取得金鑰輪替原則	列出金鑰的原則。 GetKeyRotationPolicy 作業會傳回指定金鑰保存庫中的指定金鑰原則資源。 此作業需要金鑰/取得許可權。
更新金鑰輪替原則	更新金鑰的輪替原則。 在金鑰原則中設定指定的成員。 將其他人保留為未定義。 此作業需要金鑰/更新許可權。

僅限受控 HSM (金鑰作業)

作業	描述
取得隨機位元組	從 Managed HSM 取得包含隨機值的位元組數目。

密碼編譯作業 (金鑰保存庫/受控 HSM)

作業	描述
Decrypt	解密加密資料的單一區塊。
Encrypt	使用儲存在金鑰保存庫中的加密金鑰來加密任意序列的位元組。
換行鍵	使用指定的金鑰包裝對稱金鑰。
解除包裝金鑰	使用最初用來包裝該金鑰的指定金鑰解除包裝對稱金鑰。
簽署	使用指定的索引鍵，從摘要建立簽章。
Verify	使用指定的金鑰驗證簽章。

僅) 秘密作業 (金鑰保存庫

作業	描述
取得秘密	從指定的金鑰保存庫取得指定的秘密。
取得秘密	列出指定金鑰保存庫中的秘密。
取得秘密版本	列出指定秘密的所有版本。
設定秘密	在指定的金鑰保存庫中設定秘密。
更新秘密	更新指定金鑰保存庫中與指定秘密相關聯的屬性。
刪除秘密	從指定的金鑰保存庫刪除秘密。
取得已刪除的秘密	取得指定的已刪除秘密。
取得已刪除的秘密	列出指定保存庫已刪除的秘密。
清除已刪除的秘密	永久刪除指定的秘密。
復原已刪除的秘密	將已刪除的秘密復原至最新版本。
備份密碼	備份指定的秘密。
還原秘密	將備份的秘密還原至保存庫。

僅) 儲存體帳戶金鑰管理作業 (金鑰保存庫

儲存體帳戶設定作業

作業	描述
取得儲存體帳戶	取得指定儲存體帳戶的相關資訊。 此作業需要儲存體/取得許可權。
取得儲存體帳戶	列出由指定金鑰保存庫管理的儲存體帳戶。 此作業需要儲存體/清單許可權。
更新儲存體帳戶	更新與指定儲存體帳戶相關聯的指定屬性。 此作業需要儲存體/設定/更新許可權。
設定儲存體帳戶	建立或更新新的儲存體帳戶。 此作業需要儲存體/設定許可權。
刪除儲存體帳戶	刪除儲存體帳戶。 此作業需要儲存體/刪除許可權。
取得已刪除的儲存體帳戶	取得指定的已刪除儲存體帳戶。
取得已刪除的儲存體帳戶	列出指定保存庫已刪除的儲存體帳戶。
清除已刪除的儲存體帳戶	永久刪除指定的儲存體帳戶。
將已刪除的儲存體帳戶復原	復原已刪除的儲存體帳戶。
備份儲存體帳戶	備份指定的儲存體帳戶。
還原儲存體帳戶	將備份的儲存體帳戶還原至保存庫。

儲存體帳戶金鑰作業

作業	描述
重新產生儲存體帳戶金鑰	重新產生指定儲存體帳戶的指定金鑰值。 此作業需要儲存體/重新產生金鑰許可權。

儲存體帳戶 SAS 作業

作業	描述
取得 Sas 定義	取得指定儲存體帳戶之 SAS 定義的相關資訊。 此作業需要儲存體/取得許可權。
取得 Sas 定義	列出指定儲存體帳戶的儲存體 SAS 定義。 此作業需要儲存體/listas 許可權。
設定 Sas 定義	建立或更新指定儲存體帳戶的新 SAS 定義。 此作業需要 storage/setsas 權限。
更新 Sas 定義	更新與指定 SAS 定義相關聯的指定屬性。 此作業需要 storage/setsas 權限。
刪除 Sas 定義	從指定的儲存體帳戶刪除 SAS 定義。 此作業需要 storage/deletesas 許可權。
取得已刪除的 Sas 定義	取得指定的已刪除 sas 定義。
取得已刪除的 Sas 定義	列出指定保存庫和儲存體帳戶的已刪除 SAS 定義。
復原已刪除的 Sas 定義	復原已刪除的 SAS 定義。

憑證作業僅 (金鑰保存庫)

作業	描述
取得憑證	取得憑證的相關資訊。
取得憑證	列出指定金鑰保存庫中的憑證
取得憑證版本	列出憑證的版本。
建立憑證	建立新的憑證。
匯入憑證	將憑證匯入指定的金鑰保存庫。
合併憑證	將憑證或憑證鏈結與伺服器上現有的金鑰組合並。
取得憑證作業	取得憑證的建立作業。
更新憑證作業	更新憑證作業。
刪除憑證作業	刪除特定憑證的建立作業。
更新憑證	更新與指定憑證相關聯的指定屬性。
刪除憑證	從指定的金鑰保存庫刪除憑證。
取得已刪除的憑證	擷取所指定已刪除憑證的相關資訊。
取得已刪除的憑證	列出目前可用於復原之指定保存庫中已刪除的憑證。
清除已刪除的憑證	永久刪除指定的已刪除憑證。
復原已刪除的憑證	將已刪除的憑證復原回其 /certificates 下的目前版本。
備份憑證	備份指定的憑證。
還原憑證	將備份的憑證還原至保存庫。

憑證原則作業

作業	描述
取得憑證原則	列出憑證的原則。
更新憑證原則	更新憑證的原則。

憑證連絡人作業

作業	描述
取得憑證連絡人	列出指定金鑰保存庫的憑證連絡人。
設定憑證連絡人	設定指定金鑰保存庫的憑證連絡人。
刪除憑證連絡人	刪除指定金鑰保存庫的憑證連絡人。

憑證簽發者作業

作業	描述
取得憑證簽發者	列出指定的憑證簽發者。
取得憑證簽發者	列出指定金鑰保存庫的憑證簽發者。
設定憑證簽發者	設定指定的憑證簽發者。
更新憑證簽發者	更新指定的憑證簽發者。
刪除憑證簽發者	刪除指定的憑證簽發者。

另請參閱

• 如需金鑰保存庫的概念和詳細資訊，請參閱關於 Azure 金鑰保存庫。
• 如需受控 HSM 的概念和詳細資訊，請參閱什麼是 Azure 金鑰保存庫受控 HSM？
• 如需資料平面物件的概念和詳細資訊，請參閱 關於金鑰、秘密和憑證。
• 如需建構 Azure REST API 要求的一般資訊，請參閱 Azure REST API 參考
• 如需建構金鑰保存庫 REST API 要求的特定資訊，請參閱
  • 常見的 HTTP 要求參數和標頭
  • 驗證、要求和回應
• 如需其他金鑰保存庫概念和詳細資料，請參閱下列主題
  • Key Vault 開發人員指南
  • 金鑰保存庫版本