Vaults - Purge Deleted

Service:

Key Vault

API Version:

2021-10-01

Окончательно удаляет указанное хранилище. aka Очищает удаленное хранилище ключей Azure.

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

Параметры URI

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

Ответы

Name	Type	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=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/purgeDeletedVault.json
func ExampleVaultsClient_BeginPurgeDeleted() {
	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)
	}
	poller, err := client.BeginPurgeDeleted(ctx,
		"sample-vault",
		"westus",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

Sample Response

Status code:

200

Status code:

202

Определения

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

CloudError

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

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

CloudErrorBody

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

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