Aliases - Create Or Update

Служба:: Search Service

Версия API:: 2025-03-01-preview

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

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

Параметры URI

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

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

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

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

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

Ответы

Имя	Тип	Описание
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	ErrorResponse	Ответ на ошибку.

Примеры

SearchServiceCreateOrUpdateAlias

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

HTTP

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





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

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

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

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

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

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SearchAlias	Представляет псевдоним индекса, описывающий сопоставление с именем псевдонима с индексом. Имя псевдонима можно использовать вместо имени индекса для поддерживаемых операций.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

SearchAlias

Объект

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

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