Vaults - Get Deleted

Gets the deleted Azure key vault.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}?api-version=2022-07-01

URI Parameters

Name In Required Type Description
location
path True
  • string

The location of the deleted vault.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

vaultName
path True
  • string

The name of the vault.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Retrieved information about the deleted vault.

Other Status Codes

Error response describing why the operation failed.

Examples

Retrieve a deleted vault

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault?api-version=2022-07-01

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/deletedVaults",
  "properties": {
    "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
    "location": "westus",
    "tags": {},
    "deletionDate": "2017-01-01T00:00:59Z",
    "scheduledPurgeDate": "2017-04-01T00:00:59Z",
    "purgeProtectionEnabled": true
  }
}

Definitions

CloudError

An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

DeletedVault

Deleted vault information with extended details.

DeletedVaultProperties

Properties of the deleted vault.

CloudError

An error response from Key Vault resource provider

Name Type Description
error

An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

Name Type Description
code
  • string

Error code. This is a mnemonic that can be consumed programmatically.

message
  • string

User friendly error message. The message is typically localized and may vary with service version.

DeletedVault

Deleted vault information with extended details.

Name Type Description
id
  • string

The resource ID for the deleted key vault.

name
  • string

The name of the key vault.

properties

Properties of the vault

type
  • string

The resource type of the key vault.

DeletedVaultProperties

Properties of the deleted vault.

Name Type Description
deletionDate
  • string

The deleted date.

location
  • string

The location of the original vault.

purgeProtectionEnabled
  • boolean

Purge protection status of the original vault.

scheduledPurgeDate
  • string

The scheduled purged date.

tags
  • object

Tags of the original vault.

vaultId
  • string

The resource id of the original vault.