你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Aliases - Create Or Update

服务:

Search Service

API 版本:

2024-09-01-preview

创建新的搜索别名或更新别名（如果已存在）。

PUT {endpoint}/aliases('{aliasName}')?api-version=2024-09-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	随请求一起发送的跟踪 ID，以帮助进行调试。
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=2024-09-01-preview





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

示例响应

状态代码:

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	别名的名称。