Gateway - Generate Token

サービス:

API Management

API バージョン:

2024-05-01

ゲートウェイの Shared Access Authorization Token を取得します。

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 Management サービス インスタンスで一意である必要があります。 値 '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 Management サービスの名前。
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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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=="
}

定義

名前	説明
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	ゲートウェイの Shared Access Authentication トークン値。

GatewayTokenRequestContract

Object

ゲートウェイ トークン要求コントラクトのプロパティ。

名前	型	規定値	説明
expiry	string (date-time)		トークンの有効期限。 最大トークンの有効期限は 30 日に設定されます。 日付は、ISO 8601 標準で指定された yyyy-MM-ddTHH:mm:ssZ 形式に準拠しています。
keyType	KeyType	primary	ゲートウェイ トークンの生成に使用するキー。

KeyType

列挙

再生成されるキー。

値	説明
primary
secondary