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

Gateway - Regenerate Key

服务:

API Management

API 版本:

2024-05-01

重新生成指定的网关密钥，使使用它创建的任何令牌失效。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
gatewayId	path	True	string minLength: 1 maxLength: 80	网关实体标识符。 当前 API 管理服务实例中必须是唯一的。 不得具有值“managed”
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
keyType	True	KeyType	正在重新生成密钥。

响应

名称	类型	说明
204 No Content		密钥已成功重新生成
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementGatewayRegenerateKey

示例请求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gwId/regenerateKey?api-version=2024-05-01

{
  "keyType": "primary"
}

示例响应

状态代码:

204

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GatewayKeyRegenerationRequestContract	网关密钥重新生成请求协定属性。
KeyType	正在重新生成密钥。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GatewayKeyRegenerationRequestContract

Object

网关密钥重新生成请求协定属性。

名称	类型	说明
keyType	KeyType	正在重新生成密钥。

KeyType

枚举

正在重新生成密钥。

值	说明
primary
secondary