Vaults - Purge Deleted

Service:

Key Vault

API Version:

2022-07-01

永久刪除指定的保存庫。 也稱為清除已刪除的 Azure 金鑰保存庫。

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

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string	虛刪除保存庫的位置。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vaultName	path	True	string	虛刪除保存庫的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK		保存庫已清除。
202 Accepted		正在清除保存庫。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

Purge a deleted vault

Sample Request

HTTP

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

Python

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

定義

名稱	Description
CloudError	金鑰保存庫 資源提供者的錯誤回應
CloudErrorBody	金鑰保存庫 資源提供者的錯誤回應

CloudError

金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	金鑰保存庫 資源提供者的錯誤回應

CloudErrorBody

金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。 這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。 訊息通常是本地化的，而且可能會隨著服務版本而有所不同。