你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Vaults - List Deleted

Service:

Key Vault

API Version:

2022-07-01

获取有关订阅中已删除的保管库的信息。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	DeletedVaultListResult	检索了有关订阅中所有已删除的密钥保管库的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

示例

List deleted vaults in the specified subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?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 list_deleted_vaults.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.list_deleted()
    for item in response:
        print(item)


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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault",
      "name": "vault-agile-drawer-6404",
      "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
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?api-version=2022-07-01&%24skiptoken=HY3RaoMwAEX%2fRcbeYhJrnRXKYNWOuqpME0sfNcYui0Yxade19N8ne7hcDlzOvVuKX81eKKmt4G4dooLQwgqsL2NGHUDYV6o68Z4rY1e388RtNvRQn2vNJjEaMSgNvcbneMUcsKg8BFwft8DndQ0w9hu2QOiFLRs4TsNFNHzSMBFsGvTQGvuD%2f5bVuTOw4R03vPkH%2fVqNAlzm5SxfOwh7ACOA8POTlvPjILlaU1ke8jImOc23JCppQVfZnna0DXc4ISc3vSVuRo5zJE6%2bj25C3vwk2v2kEV2mMn7PyOc1DbtNGkonnzuLym1G400uI5QRZj0efw%3d%3d"
}

定义

名称	说明
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
DeletedVault	已删除包含扩展详细信息的保管库信息。
DeletedVaultListResult	保管库列表
DeletedVaultProperties	已删除保管库的属性。

CloudError

密钥保管库资源提供程序的错误响应

名称	类型	说明
error	CloudErrorBody	密钥保管库资源提供程序的错误响应

CloudErrorBody

密钥保管库资源提供程序的错误响应

名称	类型	说明
code	string	错误代码。 这是可以编程方式使用的助记键。
message	string	用户友好的错误消息。 消息通常是本地化的，可能因服务版本而异。

DeletedVault

已删除包含扩展详细信息的保管库信息。

名称	类型	说明
id	string	已删除密钥保管库的资源 ID。
name	string	密钥保管库的名称。
properties	DeletedVaultProperties	保管库的属性
type	string	密钥保管库的资源类型。

DeletedVaultListResult

保管库列表

名称	类型	说明
nextLink	string	用于获取下一组已删除保管库的 URL。
value	DeletedVault[]	已删除保管库的列表。

DeletedVaultProperties

已删除保管库的属性。

名称	类型	说明
deletionDate	string	删除的日期。
location	string	原始保管库的位置。
purgeProtectionEnabled	boolean	清除原始保管库的保护状态。
scheduledPurgeDate	string	计划的清除日期。
tags	object	原始保管库的标记。
vaultId	string	原始保管库的资源 ID。