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

(Azure AI 搜索 REST API) 更新索引器

可以使用 HTTP PUT 请求更新现有索引器定义。 指定要在请求 URI 上更新的索引器的名称:

PUT https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]  
    Content-Type: application/json  
    api-key: [admin key]  

更新索引器定义不会自动运行它,但根据修改和关联的数据源,可能需要重置并重新运行。

URI 参数

参数 说明
服务名称 必需。 将其设置为搜索服务的唯一用户定义名称。
索引器名称 必需。 请求 URI 指定要更新的索引器的名称。
api-version 必需。 当前稳定版本为 api-version=2020-06-30。 有关更多 版本,请参阅 API 版本。

请求标头

下表介绍必需和可选的请求标头。

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 如果使用的是 Azure 角色 ,并且请求中提供了持有者令牌,则为可选,否则需要密钥。 api-key 是系统生成的唯一字符串,用于对搜索服务的请求进行身份验证。 更新请求必须包含 api-key 设置为管理密钥 (的标头,而不是) 查询密钥。 有关详细信息 ,请参阅使用密钥身份验证连接到 Azure AI 搜索

请求正文

请求正文语法与 创建索引器的语法相同。

更新现有索引器时,整个定义将替换为请求正文的内容。 通常,用于更新的最佳模式是使用 GET 检索索引器定义,对其进行修改,然后使用 PUT 更新它。

响应

对于成功的请求:“201 已创建”(如果已创建新索引器)和“204 无内容”(如果已更新现有索引器)。

另请参阅