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

Admin Keys - Get

获取指定 Azure AI 搜索服务的主要和辅助管理 API 密钥。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2024-03-01-preview

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

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

searchServiceName
path True

string

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

正则表达式模式: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

subscriptionId
path True

string

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

api-version
query True

string

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

请求头

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

string

uuid

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

响应

名称 类型 说明
200 OK

AdminKeyResult

已成功检索管理密钥,并在响应中。 可以使用主密钥或辅助密钥作为 Azure AI 搜索服务 REST API 或 SDK 中“api-key”参数的值,对搜索服务执行任何操作,包括特权操作。 特权操作包括管理索引和数据源等资源,以及上传、修改或删除索引中的数据。

Other Status Codes

CloudError

HTTP 404 (找不到) :找不到订阅、资源组或搜索服务。 HTTP 409 (冲突) :禁用指定的订阅。

安全性

azure_auth

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

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

SearchGetAdminKeys

示例请求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2024-03-01-preview

示例响应

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

定义

名称 说明
AdminKeyResult

包含给定 Azure AI 搜索服务的主要和辅助管理 API 密钥的响应。

CloudError

包含有关 API 错误的信息。

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

AdminKeyResult

包含给定 Azure AI 搜索服务的主要和辅助管理 API 密钥的响应。

名称 类型 说明
primaryKey

string

搜索服务的主管理 API 密钥。

secondaryKey

string

搜索服务的辅助管理 API 密钥。

CloudError

包含有关 API 错误的信息。

名称 类型 说明
error

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

message

string

有关错误提示错误 (详细信息/调试信息的简短说明,请参阅“error.message”属性) 。

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

名称 类型 说明
code

string

描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误情况。

details

CloudErrorBody[]

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

message

string

详细描述错误并提供调试信息的消息。

target

string

特定错误的目标 (例如,错误) 中属性的名称。