Vaults - List Deleted

Service:

Key Vault

API Version:

2021-10-01

Возвращает сведения об удаленных хранилищах в подписке.

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

Параметры URI

Name	In	Required	Type	Description
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Ответы

Name	Type	Description
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=2021-10-01

Go

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/examples/listDeletedVaults.json
func ExampleVaultsClient_NewListDeletedPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewVaultsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListDeletedPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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=2021-10-01&%24skiptoken=HY3RaoMwAEX%2fRcbeYhJrnRXKYNWOuqpME0sfNcYui0Yxade19N8ne7hcDlzOvVuKX81eKKmt4G4dooLQwgqsL2NGHUDYV6o68Z4rY1e388RtNvRQn2vNJjEaMSgNvcbneMUcsKg8BFwft8DndQ0w9hu2QOiFLRs4TsNFNHzSMBFsGvTQGvuD%2f5bVuTOw4R03vPkH%2fVqNAlzm5SxfOwh7ACOA8POTlvPjILlaU1ke8jImOc23JCppQVfZnna0DXc4ISc3vSVuRo5zJE6%2bj25C3vwk2v2kEV2mMn7PyOc1DbtNGkonnzuLym1G400uI5QRZj0efw%3d%3d"
}

Определения

CloudError	Ответ об ошибке поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке поставщика ресурсов Key Vault
DeletedVault	Удаленные сведения о хранилище с расширенными сведениями.
DeletedVaultListResult	Список хранилищ
DeletedVaultProperties	Свойства удаленного хранилища.

CloudError

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

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке поставщика ресурсов Key Vault

CloudErrorBody

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

Name	Type	Description
code	string	Код ошибки. Это mnemonic, который можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

DeletedVault

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

Name	Type	Description
id	string	Идентификатор ресурса для удаленного хранилища ключей.
name	string	Имя хранилища ключей.
properties	DeletedVaultProperties	Свойства хранилища
type	string	Тип ресурса хранилища ключей.

DeletedVaultListResult

Список хранилищ

Name	Type	Description
nextLink	string	URL-адрес для получения следующего набора удаленных хранилищ.
value	DeletedVault[]	Список удаленных хранилищ.

DeletedVaultProperties

Свойства удаленного хранилища.

Name	Type	Description
deletionDate	string	Дата удаления.
location	string	Расположение исходного хранилища.
purgeProtectionEnabled	boolean	Состояние защиты от очистки исходного хранилища.
scheduledPurgeDate	string	Запланированная дата очистки.
tags	object	Теги исходного хранилища.
vaultId	string	Идентификатор ресурса исходного хранилища.