Aliases - Create Or Update

Служба:: Search Service

Версия API:: 2026-05-01-preview

Создает новый псевдоним поиска или обновляет псевдоним, если он уже существует.

PUT {endpoint}/aliases('{aliasName}')?api-version=2026-05-01-preview

Параметры URI

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

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
If-Match		string	Определяет условие If-Match. Операция будет выполнена только в том случае, если ETag на сервере соответствует этому значению.
If-None-Match		string	Определяет условие If-None-Match. Операция будет выполнена только в том случае, если ETag на сервере не соответствует этому значению.
Prefer	True	Prefer	Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

Имя	Обязательно	Тип	Описание
indexes	True	string[]	Имя индекса, с которым сопоставляется этот псевдоним. Может быть указано только одно имя индекса.
name	True	string	Имя псевдонима.
@odata.etag		string	ETag псевдонима.

Ответы

Имя	Тип	Описание
200 OK	SearchAlias	Запрос выполнен успешно.
201 Created	SearchAlias	Запрос успешно выполнен, и в результате был создан новый ресурс.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

api-key

Тип: apiKey
В: header

OAuth2Auth

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

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceCreateOrUpdateAlias

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

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-05-01-preview





{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ],
  "@odata.etag": "0x1234568AE7E58A1"
}

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

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

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

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

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Подробности ошибки.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
Prefer	Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.
SearchAlias	Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

Подробности ошибки.

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

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

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

Prefer

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

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

Значение	Описание
return=representation

SearchAlias

Объект

Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

Имя	Тип	Описание
@odata.etag	string	ETag псевдонима.
indexes	string[]	Имя индекса, с которым сопоставляется этот псевдоним. Может быть указано только одно имя индекса.
name	string	Имя псевдонима.