Update Storage Account - Update Storage Account
更新與指定儲存體帳戶相關聯的指定屬性。 此作業需要儲存/設定/更新權限。
PATCH {vaultBaseUrl}/storage/{storage-account-name}?api-version=2025-07-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
storage-account-name
|
path | True |
string pattern: ^[0-9a-zA-Z]+$ |
儲存體帳戶的名稱。 |
|
vault
|
path | True |
string |
儲存庫名稱,例如 |
|
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| activeKeyName |
string |
目前的作用中儲存體帳戶金鑰名稱。 |
| attributes |
儲存體帳戶的屬性。 |
|
| autoRegenerateKey |
boolean |
KeyVault 是否應該管理使用者的儲存體帳戶。 |
| regenerationPeriod |
string |
以 ISO-8601 格式指定的金鑰重新產生持續時間。 |
| tags |
object |
以索引鍵值組的形式呈現應用程式特定的中繼資料。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
更新的儲存體帳戶。 |
|
| Other Status Codes |
Key Vault 錯誤回應,說明作業失敗的原因。 |
範例
Update Storage account
範例要求
PATCH https://myvault.vault.azure.net//storage/patchStrg01?api-version=2025-07-01
{
"activeKeyName": "key1",
"regenerationPeriod": "P10D"
}
範例回覆
{
"id": "https://myvault.vault.azure.net/storage/patchStrg01",
"resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc",
"activeKeyName": "key1",
"autoRegenerateKey": true,
"regenerationPeriod": "P10D",
"attributes": {
"enabled": true,
"created": 1490738386,
"updated": 1490738386,
"recoveryLevel": "Recoverable+Purgeable"
},
"tags": {
"tag1": "val1",
"tag2": "val2"
}
}
定義
| 名稱 | Description |
|---|---|
|
Deletion |
反映目前保存庫中儲存體帳戶目前有效的刪除復原層級。 如果包含 'Purgeable',則特殊許可權使用者可以永久刪除儲存體帳戶;否則,只有系統可以在保留間隔結束時清除儲存體帳戶。 |
| Error |
金鑰保存庫伺服器錯誤。 |
|
Key |
金鑰保存庫錯誤例外狀況。 |
|
Storage |
儲存體帳戶管理屬性。 |
|
Storage |
儲存體帳戶更新參數。 |
|
Storage |
儲存體帳戶套件組合包含金鑰保存庫儲存體帳戶詳細資料及其屬性。 |
DeletionRecoveryLevel
反映目前保存庫中儲存體帳戶目前有效的刪除復原層級。 如果包含 'Purgeable',則特殊許可權使用者可以永久刪除儲存體帳戶;否則,只有系統可以在保留間隔結束時清除儲存體帳戶。
| 值 | Description |
|---|---|
| Purgeable |
表示保存庫狀態,其中刪除是不可逆的作業,無法復原。 此層級對應於沒有針對 Delete 作業可用的保護;在實體層級或更高層級接受刪除作業時,資料會無法復原地遺失 (保存庫、資源群組、訂用帳戶等) |
| Recoverable+Purgeable |
表示刪除可復原的儲存庫狀態,也允許立即和永久刪除 (即清除)。 此層級可保證已刪除實體在保留間隔 (90 天) 期間的可復原性,除非要求清除作業,或取消訂閱。 如果未恢復,系統將在 90 天后永久刪除它 |
| Recoverable |
表示保存庫狀態,在該狀態下,刪除是可恢復的,但無法立即和永久刪除(即清除)。 此層級可確保在保留間隔 (90 天) 期間,以及訂用帳戶仍可用時,已刪除實體的可復原性。 如果未恢復,系統將在 90 天后永久刪除它 |
| Recoverable+ProtectedSubscription |
表示保存庫和訂閱狀態,其中刪除可在保留間隔 (90 天) 內復原,不允許立即和永久刪除 (即清除),且訂閱本身無法永久取消。 如果未恢復,系統將在 90 天后永久刪除它 |
| CustomizedRecoverable+Purgeable |
表示可復原刪除的保存庫狀態,也允許立即和永久刪除 (即當 7<= SoftDeleteRetentionInDays < 90 時清除)。 此層級可確保已刪除實體在保留間隔期間的可復原性,除非要求清除作業,或取消訂用帳戶。 |
| CustomizedRecoverable |
表示保存庫狀態,在該狀態下,刪除可復原,但無法立即永久刪除 (亦即,當 7<= SoftDeleteRetentionInDays < 90 時清除)。此層級可確保在保留間隔期間,以及訂用帳戶仍可用時,已刪除實體的可復原性。 |
| CustomizedRecoverable+ProtectedSubscription |
表示保存庫和訂閱狀態,其中刪除是可復原的,不允許立即和永久刪除 (即清除),並且當 7<= SoftDeleteRetentionInDays < 90 時無法永久取消訂閱本身。 此層級保證已刪除實體在保留間隔期間的可復原性,也反映訂用帳戶本身無法取消的事實。 |
Error
金鑰保存庫伺服器錯誤。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
錯誤碼。 |
| innererror |
金鑰保存庫伺服器錯誤。 |
|
| message |
string |
錯誤訊息。 |
KeyVaultError
金鑰保存庫錯誤例外狀況。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
金鑰保存庫伺服器錯誤。 |
StorageAccountAttributes
儲存體帳戶管理屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| created |
integer (unixtime) |
創建時間(UTC)。 |
| enabled |
boolean |
物件的已啟用狀態。 |
| recoverableDays |
integer (int32) |
softDelete 數據保留天數。 啟用 softDelete 時,值應該是 =7 和 <=90,否則應該是 >0。 |
| recoveryLevel |
反映目前保存庫中儲存體帳戶目前有效的刪除復原層級。 如果包含 'Purgeable',則特殊許可權使用者可以永久刪除儲存體帳戶;否則,只有系統可以在保留間隔結束時清除儲存體帳戶。 |
|
| updated |
integer (unixtime) |
最後更新時間(UTC)。 |
StorageAccountUpdateParameters
儲存體帳戶更新參數。
| 名稱 | 類型 | Description |
|---|---|---|
| activeKeyName |
string |
目前的作用中儲存體帳戶金鑰名稱。 |
| attributes |
儲存體帳戶的屬性。 |
|
| autoRegenerateKey |
boolean |
KeyVault 是否應該管理使用者的儲存體帳戶。 |
| regenerationPeriod |
string |
以 ISO-8601 格式指定的金鑰重新產生持續時間。 |
| tags |
object |
以索引鍵值組的形式呈現應用程式特定的中繼資料。 |
StorageBundle
儲存體帳戶套件組合包含金鑰保存庫儲存體帳戶詳細資料及其屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| activeKeyName |
string |
目前的作用中儲存體帳戶金鑰名稱。 |
| attributes |
儲存體帳戶屬性。 |
|
| autoRegenerateKey |
boolean |
KeyVault 是否應該管理使用者的儲存體帳戶。 |
| id |
string |
儲存體帳戶識別碼。 |
| regenerationPeriod |
string |
以 ISO-8601 格式指定的金鑰重新產生持續時間。 |
| resourceId |
string |
儲存體帳戶資源識別碼。 |
| tags |
object |
以索引鍵值組形式呈現的應用程式特定中繼資料 |