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

名稱	位於	必要	類型	Description
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)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
expiry	True	string (date-time)	令牌的到期時間。 令牌到期時間上限設定為 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。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementGatewayGenerateToken

範例要求

HTTP

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=="
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GatewayTokenContract	閘道存取令牌。
GatewayTokenRequestContract	閘道令牌要求合約屬性。
KeyType	正在重新產生金鑰。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GatewayTokenContract

Object

閘道存取令牌。

名稱	類型	Description
value	string	閘道的共用存取驗證令牌值。

GatewayTokenRequestContract

Object

閘道令牌要求合約屬性。

名稱	類型	預設值	Description
expiry	string (date-time)		令牌的到期時間。 令牌到期時間上限設定為 30 天。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
keyType	KeyType	primary	用來產生閘道令牌的金鑰。

KeyType

列舉型別

正在重新產生金鑰。

值	Description
primary
secondary