Vaults - Check Name Availability

Service:

Key Vault

API Version:

2021-10-01

Проверяет, является ли имя хранилища допустимым и еще не используется.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability?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	Required	Type	Description
name	True	string	Имя хранилища.
type	True	Type	Тип ресурса, Microsoft.KeyVault/vaults

Ответы

Name	Type	Description
200 OK	CheckNameAvailabilityResult	ОК . Операция проверки доступности имени хранилища прошла успешно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

Validate a vault name

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/checkNameAvailability?api-version=2021-10-01

{
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults"
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.keyvault.models.VaultCheckNameAvailabilityParameters;

/** Samples for Vaults CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/examples/checkVaultNameAvailability.json
     */
    /**
     * Sample code: Validate a vault name.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void validateAVaultName(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .vaults()
            .manager()
            .serviceClient()
            .getVaults()
            .checkNameAvailabilityWithResponse(
                new VaultCheckNameAvailabilityParameters().withName("sample-vault"), Context.NONE);
    }
}

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

Go

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/checkVaultNameAvailability.json
func ExampleVaultsClient_CheckNameAvailability() {
	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)
	}
	res, err := client.CheckNameAvailability(ctx,
		armkeyvault.VaultCheckNameAvailabilityParameters{
			Name: to.Ptr("sample-vault"),
			Type: to.Ptr("Microsoft.KeyVault/vaults"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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

Sample Response

Status code:

200

{
  "nameAvailable": true
}

Определения

CheckNameAvailabilityResult	Ответ операции CheckNameAvailability.
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
Reason	Причина, по которой не удалось использовать имя хранилища. Элемент Reason возвращается только в том случае, если NameAvailable имеет значение false.
Type	Тип ресурса, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Параметры, используемые для проверки доступности имени хранилища.

CheckNameAvailabilityResult

Ответ операции CheckNameAvailability.

Name	Type	Description
message	string	Более подробное описание значения причины в сообщении об ошибке.
nameAvailable	boolean	Логическое значение, указывающее, доступно ли имя для использования. Если значение равно true, имя доступно. Если значение равно false, то имя уже принято или является недопустимым и не может использоваться.
reason	Reason	Причина, по которой не удалось использовать имя хранилища. Элемент Reason возвращается только в том случае, если NameAvailable имеет значение false.

CloudError

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

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

CloudErrorBody

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

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

Reason

Причина, по которой не удалось использовать имя хранилища. Элемент Reason возвращается только в том случае, если NameAvailable имеет значение false.

Name	Type	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Тип ресурса, Microsoft.KeyVault/vaults

Name	Type	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Параметры, используемые для проверки доступности имени хранилища.

Name	Type	Description
name	string	Имя хранилища.
type	Type	Тип ресурса, Microsoft.KeyVault/vaults