Pools - Check Name Availability

Служба:

Managed DevOps Pools

Версия API:

2025-09-20

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
name	True	string	Имя ресурса.
type	True	DevOpsInfrastructureResourceType	Тип ресурса, который используется в качестве области проверки доступности.

Ответы

Имя	Тип	Описание
200 OK	CheckNameAvailabilityResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

Pools_CheckNameAvailability

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

HTTP

POST https://management.azure.com/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/checkNameAvailability?api-version=2025-09-20

{
  "name": "mydevopspool",
  "type": "Microsoft.DevOpsInfrastructure/pools"
}

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

Код состояния:

200

{
  "available": "Unavailable",
  "message": "Managed DevOps pool mydevopspool is already in use. Please choose a pool name that has not been taken.",
  "name": "mydevopspool",
  "reason": "AlreadyExists"
}

Определения

Имя	Описание
AvailabilityStatus	AvailabilityStatus имени.
CheckNameAvailability	Параметры, используемые для проверки доступности ресурса.
CheckNameAvailabilityReason	Код причины, объясняющий, почему имя недоступно. Будет иметь значение null, если имя доступно.
CheckNameAvailabilityResult	Ответ операции CheckNameAvailability.
DevOpsInfrastructureResourceType	Тип ресурса.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку

AvailabilityStatus

Перечисление

AvailabilityStatus имени.

Значение	Описание
Available	Название доступно.
Unavailable	Название недоступно

CheckNameAvailability

Object

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

Имя	Тип	Описание
name	string	Имя ресурса.
type	DevOpsInfrastructureResourceType	Тип ресурса, который используется в качестве области проверки доступности.

CheckNameAvailabilityReason

Перечисление

Код причины, объясняющий, почему имя недоступно. Будет иметь значение null, если имя доступно.

Значение	Описание
Invalid	Имя неверно.
AlreadyExists	Название уже существует.

CheckNameAvailabilityResult

Object

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

Имя	Тип	Описание
available	AvailabilityStatus	Статус доступности имени.
message	string	Сообщение с объяснением причины недоступности имени. Будет иметь значение null, если имя доступно.
name	string	Имя, доступность которого была проверена.
reason	CheckNameAvailabilityReason	Код причины, объясняющий, почему имя недоступно. Будет иметь значение null, если имя доступно.

DevOpsInfrastructureResourceType

Перечисление

Тип ресурса.

Значение	Описание
Microsoft.DevOpsInfrastructure/pools	Ресурс пула DevOpsInfrastructure.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.