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. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	DeletedVaultListResult	Получена информация обо всех удаленных хранилищах ключей в подписке.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

List deleted vaults in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?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 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	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
DeletedVault	Удаленные сведения о хранилище с расширенными сведениями.
DeletedVaultListResult	Список хранилищ
DeletedVaultProperties	Свойства удаленного хранилища.

CloudError

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
code	string	Код ошибки. Это мнемоника, которую можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

DeletedVault

Удаленные сведения о хранилище с расширенными сведениями.

Имя	Тип	Описание
id	string	Идентификатор ресурса для удаленного хранилища ключей.
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	Идентификатор ресурса исходного хранилища.