你当前正在访问 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=2021-04-01-preview

URI 参数

Name In Required Type Description
keyKind
path True

指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。

resourceGroupName
path True
  • string

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

searchServiceName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

请求头

Name Required Type Description
x-ms-client-request-id
  • string
uuid

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

响应

Name Type Description
200 OK

已成功重新生成指定的管理密钥。 响应中包括这两个管理员密钥,包括新重新生成的密钥。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

SearchRegenerateAdminKey

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2021-04-01-preview

Sample Response

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

定义

AdminKeyKind

指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。

AdminKeyResult

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

CloudError

包含有关 API 错误的信息。

CloudErrorBody

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

AdminKeyKind

指定要重新生成哪个密钥。 有效值包括“primary”和“secondary”。

Name Type Description
primary
  • string

搜索服务的主 API 密钥。

secondary
  • string

搜索服务的辅助 API 密钥。

AdminKeyResult

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

Name Type Description
primaryKey
  • string

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

secondaryKey
  • string

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

CloudError

包含有关 API 错误的信息。

Name Type Description
error

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

message
  • string

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

CloudErrorBody

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

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

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