Servers - Check Name Availability

Определяет, можно ли создать ресурс с указанным именем.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
name True

string

type True

CheckNameAvailabilityResourceType

Ответы

Имя Тип Описание
200 OK

CheckNameAvailabilityResponse

Запрос выполнен успешно.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Check for a server name that already exists
Check for a server name that is available
Check for a server name that is invalid

Check for a server name that already exists

Образец запроса

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Пример ответа

{
  "name": "server1",
  "available": false,
  "message": "Specified server name is already used",
  "reason": "AlreadyExists"
}

Check for a server name that is available

Образец запроса

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Пример ответа

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Образец запроса

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2025-01-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Пример ответа

{
  "name": "SERVER1",
  "available": false,
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character.",
  "reason": "Invalid"
}

Определения

Имя Описание
CheckNameAvailabilityReason

Код причины, объясняющий, почему имя недоступно. Если имя доступно, не будет определено.

CheckNameAvailabilityRequest

Запрос на проверку доступности указанного имени ресурса.

CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse

Результат проверки доступности имен.

ErrorAdditionalInfo

Ошибка управления ресурсами дополнительная информация.

ErrorDetail

Детали ошибки.

ErrorResponse

Ответ на ошибку

CheckNameAvailabilityReason

Код причины, объясняющий, почему имя недоступно. Если имя доступно, не будет определено.

Значение Описание
Invalid

Недопустимо

AlreadyExists

Ужеexists

CheckNameAvailabilityRequest

Запрос на проверку доступности указанного имени ресурса.

Имя Тип Описание
name

string

type

CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Значение Описание
Microsoft.Sql/servers

Майкрософт. SQL/серверы

CheckNameAvailabilityResponse

Результат проверки доступности имен.

Имя Тип Описание
available

boolean

Значение True, если имя доступно, в противном случае — значение false.

message

string

Сообщение, объясняющее, почему имя недоступно. Если имя доступно, не будет определено.

name

string

Имя, доступность которого была проверена.

reason

CheckNameAvailabilityReason

Код причины, объясняющий, почему имя недоступно. Если имя доступно, не будет определено.

ErrorAdditionalInfo

Ошибка управления ресурсами дополнительная информация.

Имя Тип Описание
info

object

Дополнительная информация.

type

string

Тип дополнительной информации.

ErrorDetail

Детали ошибки.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Ошибка дополнительная информация.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.