Api Management Service - Check Name Availability

Служба:

API Management

Версия API:

2024-05-01

Проверяет доступность и правильность имени службы управления API.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	ApiManagementServiceNameAvailabilityResult	Результат доступности имени проверки.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementServiceCheckNameAvailability

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

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/checkNameAvailability?api-version=2024-05-01

{
  "name": "apimService1"
}

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

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

200

{
  "nameAvailable": true,
  "reason": "Valid",
  "message": ""
}

Определения

Имя	Описание
ApiManagementServiceCheckNameAvailabilityParameters	Параметры, предоставленные операции CheckNameAvailability.
ApiManagementServiceNameAvailabilityResult	Ответ операции CheckNameAvailability.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
NameAvailabilityReason	Недопустимо указывает, что предоставленное имя не соответствует требованиям к именованию поставщика ресурсов (неправильной длины, неподдерживаемых символов и т. д.). AlreadyExists указывает, что имя уже используется и поэтому недоступно.

ApiManagementServiceCheckNameAvailabilityParameters

Object

Параметры, предоставленные операции CheckNameAvailability.

Имя	Тип	Описание
name	string	Имя для проверки доступности.

ApiManagementServiceNameAvailabilityResult

Object

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

Имя	Тип	Описание
message	string	Если причина == недопустимая, укажите пользователю причину, по которой данное имя недопустимо, и укажите требования к именованию ресурсов, чтобы пользователь смог выбрать допустимое имя. Если причина == AlreadyExists, объясните, что уже используется, и направьте их, чтобы выбрать другое имя.
nameAvailable	boolean	Значение true, если имя доступно и может использоваться для создания новой службы управления API; в противном случае значение false.
reason	NameAvailabilityReason	Недопустимо указывает, что предоставленное имя не соответствует требованиям к именованию поставщика ресурсов (неправильной длины, неподдерживаемых символов и т. д.). AlreadyExists указывает, что имя уже используется и поэтому недоступно.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

NameAvailabilityReason

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

Недопустимо указывает, что предоставленное имя не соответствует требованиям к именованию поставщика ресурсов (неправильной длины, неподдерживаемых символов и т. д.). AlreadyExists указывает, что имя уже используется и поэтому недоступно.

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