通过

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

Query Keys - Create

  • 参考
服务:
Search Management
API 版本:
2025-05-01

为指定的搜索服务生成新的查询密钥。 每个服务最多可以创建 50 个查询密钥。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2025-05-01

URI 参数

名称 在 必需 类型 说明
name
 path True

string

新查询 API 密钥的名称。
resourceGroupName
 path True

string

当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

与指定资源组关联的 Azure AI 搜索服务的名称。
subscriptionId
 path True

string

Microsoft Azure 订阅的唯一标识符。 可以从 Azure 资源管理器 API 或门户获取此值。
api-version
 query True

string

要用于每个请求的 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string (uuid)

一个客户端生成的 GUID 值，用于标识此请求。 如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。

响应

名称 类型 说明
200 OK

QueryKey

查询密钥已成功创建并处于响应中。 可以使用查询键作为 Azure AI 搜索服务 REST API 或 SDK 中“api-key”参数的值，对搜索索引执行只读操作，例如按 ID 查询和查找文档。
Other Status Codes

CloudError

HTTP 404（找不到）：找不到订阅、资源组或搜索服务。 HTTP 409 （冲突）：已禁用指定的订阅。

安全性

azure_auth

指定Microsoft标识平台上支持的隐式授权流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

SearchCreateQueryKey

示例请求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-05-01

示例响应

状态代码:
200 
{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

定义

名称 说明
CloudError

包含有关 API 错误的信息。
CloudErrorBody

描述具有错误代码和消息的特定 API 错误。
QueryKey

介绍给定 Azure AI 搜索服务的 API 密钥，该服务传达对索引文档集合的只读权限。

CloudError

Object

包含有关 API 错误的信息。

名称 类型 说明
error

CloudErrorBody

描述具有错误代码和消息的特定 API 错误。
message

string

提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

Object

描述具有错误代码和消息的特定 API 错误。

名称 类型 说明
code

string

比 HTTP 状态代码更准确地描述错误条件的错误代码。 可用于以编程方式处理特定错误案例。
details

CloudErrorBody[]

包含与此错误相关的嵌套错误。
message

string

详细说明错误并提供调试信息的消息。
target

string

特定错误的目标（例如，错误中属性的名称）。

QueryKey

Object

介绍给定 Azure AI 搜索服务的 API 密钥，该服务传达对索引文档集合的只读权限。

名称 类型 说明
key

string

查询 API 密钥的值。
name

string

查询 API 密钥的名称。 查询名称是可选的，但分配名称有助于记住其用法。