Azure API Management には、開発者ポータル テンプレートで使用するための次のコントロールが用意されています。
コントロールを使用するには、開発者ポータル テンプレートの目的の場所に配置します。 次の例に示すように、app-actions コントロールなどの一部のコントロールにはパラメーターがあります。
<app-actions params="{ appId: '{{app.id}}' }"></app-actions>
パラメーターの値は、テンプレートのデータ モデルの一部として渡されます。 ほとんどの場合、コントロールが正しく動作するように、指定された例を各コントロールに貼り付けることができます。 パラメーター値の詳細については、コントロールを使用できる各テンプレートのデータ モデル セクションを参照してください。
テンプレートの操作方法の詳細については、テンプレートを使用して API Management 開発者ポータルをカスタマイズする方法に関するページを参照してください。
注
以下のドキュメントの内容は、非推奨の開発者ポータルに関するものです。 2023 年 10 月に廃止され、すべての API Management サービスから削除されるまで、通常どおりに引き続き使用できます。 非推奨のポータルでは、重要なセキュリティ更新プログラムのみを受信します。 詳細については、次の記事を参照してください。
対象: デベロッパー | ベーシック | スタンダード | プレミアム
開発者ポータル テンプレート ページ コントロール
- アプリ アクション
- 基本サインイン を行う
- ページングコントロール
- プロバイダー
- search-control
- サインアップ
- 購読ボタンを する
- サブスクリプション キャンセル
アプリのアクション
app-actions コントロールは、開発者ポータルのユーザー プロファイル ページでアプリケーションを操作するためのユーザー インターフェイスを提供します。
使用方法
<app-actions params="{ appId: '{{app.id}}' }"></app-actions>
パラメーター
| パラメーター | 説明 |
|---|---|
| アプリID | アプリケーションの ID。 |
開発者ポータル テンプレート
app-actions コントロールは、次の開発者ポータル テンプレートで使用できます。
基本サインイン
basic-signin コントロールは、開発者ポータルのサインイン ページでユーザーのサインイン情報を収集するためのコントロールを提供します。
使用方法
<basic-SignIn></basic-SignIn>
パラメーター
なし。
開発者ポータル テンプレート
basic-signin コントロールは、次の開発者ポータル テンプレートで使用できます。
ページ制御
paging-control は、アイテムの一覧を表示する開発者ポータル ページにページング機能を提供します。
使用方法
<paging-control></paging-control>
パラメーター
なし。
開発者ポータル テンプレート
paging-control コントロールは、次の開発者ポータル テンプレートで使用できます。
プロバイダー
providers コントロールは、開発者ポータルのサインイン ページで認証プロバイダーを選択するためのコントロールを提供します。
を制御します。
使用方法
<providers></providers>
パラメーター
なし。
開発者ポータル テンプレート
providers コントロールは、次の開発者ポータル テンプレートで使用できます。
検索コントロール
search-control は、アイテムの一覧を表示する開発者ポータル ページの検索機能を提供します。
検索コントロール APIM 検索コントロールAPIM search control
使用方法
<search-control></search-control>
パラメーター
なし。
開発者ポータル テンプレート
search-control コントロールは、次の開発者ポータル テンプレートで使用できます。
サインアップ
sign-up コントロールは、開発者ポータルのサインアップ ページでユーザー プロファイル情報を収集するためのコントロールを提供します。
使用方法
<sign-up></sign-up>
パラメーター
なし。
開発者ポータル テンプレート
sign-up コントロールは、次の開発者ポータル テンプレートで使用できます。
購読ボタン
subscribe-button は、ユーザーを製品にサブスクライブするためのコントロールを提供します。
使用方法
<subscribe-button></subscribe-button>
パラメーター
なし。
開発者ポータル テンプレート
subscribe-button コントロールは、次の開発者ポータル テンプレートで使用できます。
サブスクリプションのキャンセル
subscription-cancel コントロールは、開発者ポータルのユーザー プロファイル ページで製品のサブスクリプションを取り消すコントロールを提供します。
使用方法
<subscription-cancel params="{ subscriptionId: '{{subscription.id}}', cancelUrl: '{{subscription.cancelUrl}}' }">
</subscription-cancel>
パラメーター
| パラメーター | 説明 |
|---|---|
| サブスクリプションID | 取り消すサブスクリプションの ID。 |
| cancelUrl | サブスクリプションは URL を取り消します。 |
開発者ポータル テンプレート
subscription-cancel コントロールは、次の開発者ポータル テンプレートで使用できます。
次のステップ
テンプレートの操作方法の詳細については、テンプレートを使用して API Management 開発者ポータルをカスタマイズする方法に関するページを参照してください。