Vaults - Check Name Availability

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

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

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

Ответы

Name Type Description
200 OK

ОК — операция проверки доступности имени хранилища прошла успешно.

Other Status Codes

Ошибочный ответ, описывающий причину сбоя операции.

Примеры

Validate a vault name

Sample Request

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"
}

Sample Response

{
  "nameAvailable": true
}

Определения

CheckNameAvailabilityResult

Ответ операции Чеккнамеаваилабилити.

CloudError

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

CloudErrorBody

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

Reason

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

Type

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

VaultCheckNameAvailabilityParameters

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

CheckNameAvailabilityResult

Ответ операции Чеккнамеаваилабилити.

Name Type Description
message
  • string

Сообщение об ошибке, объясняющее значение причины более подробно.

nameAvailable
  • boolean

Логическое значение, указывающее, доступно ли имя для использования. Если задано значение true, имя доступно. Если значение равно false, то имя уже занято или является недопустимым и не может быть использовано.

reason

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

CloudError

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

Name Type Description
error

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

CloudErrorBody

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

Name Type Description
code
  • string

Код ошибки. Это назначенная клавиша, которую можно использовать программно.

message
  • string

Понятное пользователю сообщение об ошибке. Обычно это сообщение локализуется и может отличаться в зависимости от версии службы.

Reason

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

Name Type Description
AccountNameInvalid
  • string
AlreadyExists
  • string

Type

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

Name Type Description
Microsoft.KeyVault/vaults
  • string

VaultCheckNameAvailabilityParameters

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

Name Type Description
name
  • string

Имя хранилища.

type

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