你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Admin Keys - Regenerate
重新生成主要或辅助管理 API 密钥。 每次你只能重新生成一个密钥。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2024-03-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
key
|
path | True |
指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。 |
|
resource
|
path | True |
string |
当前订阅中的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
search
|
path | True |
string |
与指定资源组关联的 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 |
已成功重新生成指定的管理密钥。 这两个管理密钥都包含在响应中,包括新重新生成的密钥。 |
|
Other Status Codes |
HTTP 404 (找不到) :找不到订阅、资源组或搜索服务。 HTTP 409 (冲突) :禁用指定的订阅。 |
安全性
azure_auth
指定 Microsoft 标识平台上支持的隐式授权流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
SearchRegenerateAdminKey
示例请求
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2024-03-01-preview
示例响应
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
定义
名称 | 说明 |
---|---|
Admin |
指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。 |
Admin |
包含给定 Azure AI 搜索服务的主管理员 API 密钥和辅助管理员 API 密钥的响应。 |
Cloud |
包含有关 API 错误的信息。 |
Cloud |
描述具有错误代码和消息的特定 API 错误。 |
AdminKeyKind
指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。
名称 | 类型 | 说明 |
---|---|---|
primary |
string |
搜索服务的主 API 密钥。 |
secondary |
string |
搜索服务的辅助 API 密钥。 |
AdminKeyResult
包含给定 Azure AI 搜索服务的主管理员 API 密钥和辅助管理员 API 密钥的响应。
名称 | 类型 | 说明 |
---|---|---|
primaryKey |
string |
搜索服务的主管理 API 密钥。 |
secondaryKey |
string |
搜索服务的辅助管理 API 密钥。 |
CloudError
包含有关 API 错误的信息。
名称 | 类型 | 说明 |
---|---|---|
error |
描述具有错误代码和消息的特定 API 错误。 |
|
message |
string |
有关错误 (详细信息/调试信息的简要说明,请参阅“error.message”属性) 。 |
CloudErrorBody
描述具有错误代码和消息的特定 API 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
一个错误代码,它比 HTTP 状态代码更准确地描述错误条件。 可用于以编程方式处理特定错误情况。 |
details |
包含与此错误相关的嵌套错误。 |
|
message |
string |
一条消息,详细说明错误并提供调试信息。 |
target |
string |
特定错误的目标 (例如,错误) 中的属性的名称。 |