Share via


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 參數

名稱 位於 必要 類型 Description
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

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

要求本文

名稱 必要 類型 Description
expiry True

string

令牌的到期時間。 令牌到期時間上限設定為 30 天。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

keyType True

KeyType

用來產生閘道令牌的金鑰。

回應

名稱 類型 Description
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

名稱 Description
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=="
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

GatewayTokenContract

閘道存取令牌。

GatewayTokenRequestContract

閘道令牌要求合約屬性。

KeyType

正在重新產生金鑰。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單,以防發生驗證錯誤。

error.message

string

人類可閱讀的錯誤表示法。

GatewayTokenContract

閘道存取令牌。

名稱 類型 Description
value

string

閘道的共用存取驗證令牌值。

GatewayTokenRequestContract

閘道令牌要求合約屬性。

名稱 類型 預設值 Description
expiry

string

令牌的到期時間。 令牌到期時間上限設定為 30 天。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

keyType

KeyType

primary

用來產生閘道令牌的金鑰。

KeyType

正在重新產生金鑰。

名稱 類型 Description
primary

string

secondary

string