Get Deleted Storage Accounts - Get Deleted Storage Accounts

Lists deleted storage accounts for the specified vault.
The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.

GET {vaultBaseUrl}/deletedstorage?api-version=7.4
GET {vaultBaseUrl}/deletedstorage?maxresults={maxresults}&api-version=7.4

URI Parameters

Name In Required Type Description
vaultBaseUrl
path True

string

The vault name, for example https://myvault.vault.azure.net.

api-version
query True

string

Client API version.

maxresults
query

integer

int32

Maximum number of results to return in a page. If not specified the service will return up to 25 results.

Responses

Name Type Description
200 OK

DeletedStorageListResult

A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts.

Other Status Codes

KeyVaultError

Key Vault error response describing why the operation failed.

Examples

List Deleted Storage Accounts

Sample Request

GET https://myvault.vault.azure.net//deletedstorage?api-version=7.4

Sample Response

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/storage/listDeletedStorage01",
      "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc1",
      "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listDeletedStorage01",
      "scheduledPurgeDate": 1490790000,
      "deletedDate": 1490760000,
      "attributes": {
        "enabled": true,
        "created": 1490738386,
        "updated": 1490738386,
        "recoveryLevel": "Recoverable+Purgeable"
      },
      "tags": {
        "tag1": "val1",
        "tag2": "val2"
      }
    },
    {
      "id": "https://myvault.vault.azure.net/storage/listDeletedStorage02",
      "resourceId": "/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc2",
      "recoveryId": "https://myvault.vault.azure.net/deletedstorage/listDeletedStorage02",
      "scheduledPurgeDate": 1490790000,
      "deletedDate": 1490760000,
      "attributes": {
        "enabled": true,
        "created": 1490738386,
        "updated": 1490738386,
        "recoveryLevel": "Recoverable+Purgeable"
      },
      "tags": {
        "tag3": "val3",
        "tag4": "val4"
      }
    }
  ],
  "nextLink": "https://{BaseUri}/storage?api-version=7.2&%24skiptoken=<token>"
}

Definitions

Name Description
DeletedStorageAccountItem

The deleted storage account item containing metadata about the deleted storage account.

DeletedStorageListResult

The deleted storage account list result

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.

Error

The key vault server error.

KeyVaultError

The key vault error exception.

StorageAccountAttributes

The storage account management attributes.

DeletedStorageAccountItem

The deleted storage account item containing metadata about the deleted storage account.

Name Type Description
attributes

StorageAccountAttributes

The storage account management attributes.

deletedDate

integer

The time when the storage account was deleted, in UTC

id

string

Storage identifier.

recoveryId

string

The url of the recovery object, used to identify and recover the deleted storage account.

resourceId

string

Storage account resource Id.

scheduledPurgeDate

integer

The time when the storage account is scheduled to be purged, in UTC

tags

object

Application specific metadata in the form of key-value pairs.

DeletedStorageListResult

The deleted storage account list result

Name Type Description
nextLink

string

The URL to get the next set of deleted storage accounts.

value

DeletedStorageAccountItem[]

A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.

Name Type Description
CustomizedRecoverable

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.

CustomizedRecoverable+ProtectedSubscription

string

Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

CustomizedRecoverable+Purgeable

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.

Purgeable

string

Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)

Recoverable

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered

Recoverable+ProtectedSubscription

string

Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered

Recoverable+Purgeable

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

Error

The key vault server error.

Name Type Description
code

string

The error code.

innererror

Error

The key vault server error.

message

string

The error message.

KeyVaultError

The key vault error exception.

Name Type Description
error

Error

The key vault server error.

StorageAccountAttributes

The storage account management attributes.

Name Type Description
created

integer

Creation time in UTC.

enabled

boolean

the enabled state of the object.

recoverableDays

integer

softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.

recoveryLevel

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.

updated

integer

Last updated time in UTC.