Vaults - Purge Deleted

Reference

Service:: Key Vault

API Version:: 2022-07-01

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The location of the soft-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 soft-deleted vault.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK		The vault is purged.
202 Accepted		Vault is being purged.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

Purge a deleted vault

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault/purge?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 purge_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.begin_purge_deleted(
        vault_name="sample-vault",
        location="westus",
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/purgeDeletedVault.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

Status code:: 202

Definitions

Name	Description
CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider

CloudError

An error response from Key Vault resource provider

Name	Type	Description
error	CloudErrorBody	An error response from Key Vault resource provider

CloudErrorBody