Query Keys - Delete
删除指定的查询键。 与管理密钥不同，不会重新生成查询密钥。 重新生成查询密钥的过程是删除并重新创建它。
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}?api-version=2025-02-01-previewURI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
key
|
path | True |
string |
要删除的查询密钥。 查询键按值而不是名称标识。 |
|
resource
|
path | True |
string |
当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
与指定资源组关联的 Azure AI 搜索服务的名称。 |
|
subscription
|
path | True |
string |
Microsoft Azure 订阅的唯一标识符。 可以从 Azure 资源管理器 API 或门户获取此值。 |
|
api-version
|
query | True |
string |
要用于每个请求的 API 版本。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
一个客户端生成的 GUID 值，用于标识此请求。 如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
已成功删除查询密钥。 |
|
| 204 No Content |
已成功删除查询密钥。 |
|
| 404 Not Found |
找不到订阅、资源组、搜索服务或查询密钥。 |
|
| Other Status Codes |
HTTP 409 （冲突）：已禁用指定的订阅。 |
安全性
azure_auth
指定Microsoft标识平台上支持的隐式授权流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
SearchDeleteQueryKey
示例请求
DELETE https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/deleteQueryKey/<a query API key>?api-version=2025-02-01-preview
示例响应
定义
| 名称 | 说明 |
|---|---|
|
Cloud |
包含有关 API 错误的信息。 |
|
Cloud |
描述具有错误代码和消息的特定 API 错误。 |
CloudError
包含有关 API 错误的信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
描述具有错误代码和消息的特定 API 错误。 |
|
| message |
string |
提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。 |
CloudErrorBody
描述具有错误代码和消息的特定 API 错误。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
比 HTTP 状态代码更准确地描述错误条件的错误代码。 可用于以编程方式处理特定错误案例。 |
| details |
包含与此错误相关的嵌套错误。 |
|
| message |
string |
详细说明错误并提供调试信息的消息。 |
| target |
string |
特定错误的目标（例如，错误中属性的名称）。 |