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

Gateway - Generate Token

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

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

URI 参数

名称 必需 类型 说明
gatewayId
path True

string

网关实体标识符。 在当前API 管理服务实例中必须是唯一的。 不得具有值“managed”

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
expiry True

string

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

keyType True

KeyType

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

响应

名称 类型 说明
200 OK

GatewayTokenContract

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

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGatewayGenerateToken

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2022-08-01

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

Sample Response

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

GatewayTokenContract

网关访问令牌。

GatewayTokenRequestContract

网关令牌请求协定属性。

KeyType

正在重新生成的密钥。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

GatewayTokenContract

网关访问令牌。

名称 类型 说明
value

string

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

GatewayTokenRequestContract

网关令牌请求协定属性。

名称 类型 默认值 说明
expiry

string

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

keyType

KeyType

primary

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

KeyType

正在重新生成的密钥。

名称 类型 说明
primary

string

secondary

string