Services - Check Name Availability
Проверяет, доступно ли указанное имя службы поиска для использования. Имена служб поиска должны быть глобально уникальными, так как они являются частью универсального кода ресурса ресурса (https://< name.search.windows.net>).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID). |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Значение GUID, созданное клиентом, идентифицирующее этот запрос. Если этот параметр указан, он будет включен в сведения о ответе в качестве способа отслеживания запроса. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| name | True |
string |
Имя службы поиска для проверки. Имена служб поиска должны содержать только строчные буквы, цифры или дефисы, не могут использовать тире в качестве первых двух или последних символов, не могут содержать последовательные дефисы и должны содержать от 2 до 60 символов в длину. |
| type | True |
enum:
search |
Тип ресурса, имя которого необходимо проверить. Это значение всегда должно быть "searchServices". |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
SearchCheckNameAvailability
Образец запроса
Пример ответа
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Определения
| Имя | Описание |
|---|---|
|
Check |
Входные данные API доступности имен проверки. |
|
Check |
Выходные данные API доступности имен проверки. |
|
Cloud |
Содержит сведения об ошибке API. |
|
Cloud |
Описывает определенную ошибку API с кодом ошибки и сообщением. |
|
Unavailable |
Причина, по которой имя недоступно. "Недопустимо" указывает, что предоставленное имя не соответствует требованиям именования (неправильной длины, неподдерживаемых символов и т. д.). "AlreadyExists" указывает, что имя уже используется и поэтому недоступно. |
CheckNameAvailabilityInput
Входные данные API доступности имен проверки.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя службы поиска для проверки. Имена служб поиска должны содержать только строчные буквы, цифры или дефисы, не могут использовать тире в качестве первых двух или последних символов, не могут содержать последовательные дефисы и должны содержать от 2 до 60 символов в длину. |
| type |
enum:
search |
Тип ресурса, имя которого необходимо проверить. Это значение всегда должно быть "searchServices". |
CheckNameAvailabilityOutput
Выходные данные API доступности имен проверки.
| Имя | Тип | Описание |
|---|---|---|
| message |
string |
Сообщение, объясняющее, почему имя недопустимо и предоставляет требования к именованию ресурсов. Доступно только в том случае, если значение "Invalid" возвращается в свойстве "причина". |
| nameAvailable |
boolean |
Значение, указывающее, доступно ли имя. |
| reason |
Причина, по которой имя недоступно. "Недопустимо" указывает, что предоставленное имя не соответствует требованиям именования (неправильной длины, неподдерживаемых символов и т. д.). "AlreadyExists" указывает, что имя уже используется и поэтому недоступно. |
CloudError
Содержит сведения об ошибке API.
| Имя | Тип | Описание |
|---|---|---|
| error |
Описывает определенную ошибку API с кодом ошибки и сообщением. |
|
| message |
string |
Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message). |
CloudErrorBody
Описывает определенную ошибку API с кодом ошибки и сообщением.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок. |
| details |
Содержит вложенные ошибки, связанные с этой ошибкой. |
|
| message |
string |
Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке. |
| target |
string |
Целевой объект конкретной ошибки (например, имя свойства в ошибке). |
UnavailableNameReason
Причина, по которой имя недоступно. "Недопустимо" указывает, что предоставленное имя не соответствует требованиям именования (неправильной длины, неподдерживаемых символов и т. д.). "AlreadyExists" указывает, что имя уже используется и поэтому недоступно.
| Значение | Описание |
|---|---|
| Invalid |
Имя службы поиска не соответствует требованиям именования. |
| AlreadyExists |
Имя службы поиска уже назначено другой службе поиска. |