Vaults - Get Deleted

Reference

Service:: Key Vault

API Version:: 2022-07-01

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	DeletedVault	Retrieved information about the deleted vault.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

Retrieve a deleted vault

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python get_deleted_vault.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.get_deleted(
        vault_name="sample-vault",
        location="westus",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getDeletedVault.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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

Name	Description
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	CloudErrorBody	An error response from Key Vault resource provider

CloudErrorBody