通过

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

Gateway - Generate Token

服务:
API Management
API 版本:
2024-05-01

获取网关的共享访问授权令牌。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?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 版本。

请求正文

名称 必需 类型 说明
expiry True

string (date-time)

令牌的到期时间。 最大令牌到期时间设置为 30 天。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
keyType True

KeyType

用于生成网关令牌的密钥。

响应

名称 类型 说明
200 OK

GatewayTokenContract

响应正文包含网关的授权令牌。
Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGatewayGenerateToken

示例请求

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

{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

示例响应

状态代码:
200 
{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
GatewayTokenContract

网关访问令牌。
GatewayTokenRequestContract

网关令牌请求协定属性。
KeyType

正在重新生成密钥。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GatewayTokenContract

Object

网关访问令牌。

名称 类型 说明
value

string

网关的共享访问身份验证令牌值。

GatewayTokenRequestContract

Object

网关令牌请求协定属性。

名称 类型 默认值 说明
expiry

string (date-time)

令牌的到期时间。 最大令牌到期时间设置为 30 天。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
keyType

KeyType

primary

用于生成网关令牌的密钥。

KeyType

枚举

正在重新生成密钥。

值 说明
primary
secondary