Поделиться через


Communication Services - Check Name Availability

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

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

Параметры URI

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

string

uuid

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

api-version
query True

string

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

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

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

string

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

type True

string

Тип ресурса.

Ответы

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

CheckNameAvailabilityResponse

Успех. В ответе описывается доступность имени.

Other Status Codes

ErrorResponse

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

Примеры

Check name availability available
Check name availability unavailable

Check name availability available

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

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

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

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

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

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

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

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

Определения

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

Причина, по которой данное имя недоступно.

CheckNameAvailabilityResponse

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

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

NameAvailabilityParameters

Data POST-ed в действие nameAvailability

CheckNameAvailabilityReason

Причина, по которой данное имя недоступно.

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

string

Invalid

string

CheckNameAvailabilityResponse

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

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

string

Подробная причина, по которой доступно данное имя.

nameAvailable

boolean

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

reason

CheckNameAvailabilityReason

Причина, по которой данное имя недоступно.

ErrorAdditionalInfo

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

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

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

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

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

ErrorDetail

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

NameAvailabilityParameters

Data POST-ed в действие nameAvailability

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

string

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

type

string

Тип ресурса.