Namespaces - Check Name Availability

Служба:

Relay

Версия API:

2024-01-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия КЛИЕНТСКОго API.

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

Имя	Тип	Описание
parameters	CheckNameAvailability	Параметры для проверки доступности указанного имени пространства имен.

Ответы

Имя	Тип	Описание
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	олицетворения учетной записи пользователя

Примеры

RelayCheckNameAvailability

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

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.Relay/checkNameAvailability?api-version=2024-01-01

{
  "name": "example-RelayNamespace1321"
}

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

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

200

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

Определения

Имя	Описание
CheckNameAvailability	Параметры для проверки доступности указанного имени пространства имен.
CheckNameAvailabilityResult	Описание свойств запроса на доступность имени проверки.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
UnavailableReason	Причина недоступности пространства имен.

CheckNameAvailability

Object

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

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

CheckNameAvailabilityResult

Object

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

Имя	Тип	Описание
message	string	Подробные сведения о причине, связанной с пространством имен.
nameAvailable	boolean	Значение, указывающее, что пространство имен доступно. Возвращает значение true, если пространство имен доступно; в противном случае значение false.
reason	UnavailableReason	Причина недоступности пространства имен.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

UnavailableReason

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

Причина недоступности пространства имен.

Значение	Описание
InvalidName
NameInLockdown
NameInUse
None
SubscriptionIsDisabled
TooManyNamespaceInCurrentSubscription