Restore Secret - Restore Secret
將備份的秘密還原至保存庫。
將備份的秘密及其所有版本還原至保存庫。 這項作業需要秘密/還原許可權。
POST {vaultBaseUrl}/secrets/restore?api-version=7.4
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
vault
|
path | True |
string |
儲存庫名稱,例如 https://myvault.vault.azure.net。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
value | True |
string |
與秘密配套相關聯的備份 Blob。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
保存庫中還原的秘密配套。 |
|
Other Status Codes |
金鑰保存庫 錯誤回應,描述作業失敗的原因。 |
範例
RestoreSecret
Sample Request
POST https://myvault.vault.azure.net//secrets/restore?api-version=7.4
{
"value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ"
}
Sample Response
{
"contentType": "text",
"id": "https://myvault.vault.azure.net/secrets/SecretBackupRestoreTest/01ddd6e3a0d34d35bb5bccecb1251837",
"attributes": {
"enabled": true,
"nbf": 1262332800,
"exp": 1893484800,
"created": 1493938113,
"updated": 1493938113,
"recoveryLevel": "Recoverable+Purgeable"
}
}
定義
名稱 | Description |
---|---|
Deletion |
反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」,則特殊許可權使用者可以永久刪除秘密;否則,只有系統可以在保留間隔結束時清除秘密。 |
Error |
金鑰儲存庫伺服器錯誤。 |
Key |
金鑰保存庫錯誤例外狀況。 |
Secret |
秘密管理屬性。 |
Secret |
包含值、標識碼及其屬性的秘密。 |
Secret |
秘密還原參數。 |
DeletionRecoveryLevel
反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」,則特殊許可權使用者可以永久刪除秘密;否則,只有系統可以在保留間隔結束時清除秘密。
名稱 | 類型 | Description |
---|---|---|
CustomizedRecoverable |
string |
表示可復原刪除的保存庫狀態,而不可能發生立即和永久刪除 (,也就是在 7<= SoftDeleteRetentionInDays < 90) 時清除。此層級保證在保留間隔期間和訂用帳戶仍可使用時,已刪除實體的復原能力。 |
CustomizedRecoverable+ProtectedSubscription |
string |
表示無法復原刪除的保存庫和訂用帳戶狀態、立即和永久刪除 (亦即不允許清除) ,而且當 7<= SoftDeleteRetentionInDays < 90 時,無法永久取消訂用帳戶本身。 此層級保證在保留間隔期間刪除的實體可復原性,同時反映無法取消訂閱本身的事實。 |
CustomizedRecoverable+Purgeable |
string |
表示可復原刪除的保存庫狀態,也允許立即和永久刪除 (,也就是在 7<= SoftDeleteRetentionInDays < 90) 時清除。 除非要求清除作業或取消訂閱,否則此層級可確保在保留間隔期間刪除實體的復原能力。 |
Purgeable |
string |
表示刪除是無法復原作業的保存庫狀態,而無法復原。 此層級對應至刪除作業沒有可用的保護;在實體層級或更高層級接受刪除作業時,數據無法復原, (保存庫、資源群組、訂用帳戶等 ) |
Recoverable |
string |
表示可復原刪除的保存庫狀態,而不需要立即和永久刪除 (亦即清除) 。 此層級可確保在保留間隔期間 (90 天) 且訂用帳戶仍可使用時,刪除實體的復原能力。 系統會在 90 天后永久刪除,如果未復原,則為 |
Recoverable+ProtectedSubscription |
string |
表示保存庫和訂用帳戶狀態,其中刪除可在保留間隔內復原 (90 天) 、立即和永久刪除 (亦即不允許清除) ,以及無法永久取消訂用帳戶本身。 系統會在 90 天后永久刪除,如果未復原,則為 |
Recoverable+Purgeable |
string |
表示可復原刪除的保存庫狀態,也允許立即和永久刪除 (,也就是清除) 。 除非要求清除作業或取消訂用帳戶,否則此層級可確保在保留間隔期間 (90 天) ,否則已刪除實體的復原能力。 系統會在 90 天后永久刪除,如果未復原,則為 |
Error
金鑰儲存庫伺服器錯誤。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
innererror |
金鑰儲存庫伺服器錯誤。 |
|
message |
string |
錯誤訊息。 |
KeyVaultError
金鑰保存庫錯誤例外狀況。
名稱 | 類型 | Description |
---|---|---|
error |
金鑰儲存庫伺服器錯誤。 |
SecretAttributes
秘密管理屬性。
名稱 | 類型 | Description |
---|---|---|
created |
integer |
以 UTC 為單位的建立時間。 |
enabled |
boolean |
判斷物件是否已啟用。 |
exp |
integer |
UTC 的到期日。 |
nbf |
integer |
不在UTC的日期之前。 |
recoverableDays |
integer |
softDelete 數據保留天數。 啟用 softDelete 時,值應該是 =7 和 <=90,否則為 >0。 |
recoveryLevel |
反映目前保存庫中秘密目前生效的刪除復原層級。 如果它包含「可清除」,則特殊許可權使用者可以永久刪除秘密;否則,只有系統可以在保留間隔結束時清除秘密。 |
|
updated |
integer |
上次以UTC更新的時間。 |
SecretBundle
包含值、標識碼及其屬性的秘密。
名稱 | 類型 | Description |
---|---|---|
attributes |
秘密管理屬性。 |
|
contentType |
string |
秘密的內容類型。 |
id |
string |
秘密標識碼。 |
kid |
string |
如果這是 KV 憑證的秘密備份,則此欄位會指定對應密鑰備份 KV 憑證。 |
managed |
boolean |
如果秘密的存留期是由金鑰保存庫管理,則為 True。 如果這是憑證的秘密備份,則 Managed 會是 true。 |
tags |
object |
以機碼/值組的形式應用程式特定元數據。 |
value |
string |
秘密值。 |
SecretRestoreParameters
秘密還原參數。
名稱 | 類型 | Description |
---|---|---|
value |
string |
與秘密配套相關聯的備份 Blob。 |