次の方法で共有

Azure API Management テンプレートのデータ モデル リファレンス

このトピックでは、Azure API Management の開発者ポータル テンプレートのデータ モデルで使用される一般的な項目のエンティティと型の表現について説明します。

テンプレートの操作方法の詳細については、テンプレートを使用して API Management 開発者ポータルをカスタマイズする方法に関するページを参照してください。

注

以下のドキュメントの内容は、非推奨の開発者ポータルに関するものです。 2023 年 10 月に廃止され、すべての API Management サービスから削除されるまで、通常どおりに引き続き使用できます。 非推奨のポータルでは、重要なセキュリティ更新プログラムのみを受信します。 詳細については、次の記事を参照してください。

対象: 開発者 | ベーシック | スタンダード | プレミアム

リファレンス

API (アプリケーション・プログラミング・インターフェース)

API エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
id ひも リソース識別子。 現在の API Management サービス インスタンス内の API を一意に識別します。 この値は、 apis/{id} の形式の有効な相対 URL です。ここで、 {id} は API 識別子です。 このプロパティは読み取り専用です。
name ひも API の名前。 空にしてはいけません。 最大長は 100 文字です。
description ひも API の説明。 空にしてはいけません。 HTML 書式設定タグを含めることができます。 最大長は 1000 文字です。
serviceUrl ひも この API を実装するバックエンド サービスの絶対 URL。
path ひも この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
protocols 数値の配列 この API の操作を呼び出すことができるプロトコルについて説明します。 使用できる値は、 1 - http と 2 - https、またはその両方です。
authenticationSettings 承認サーバーの認証設定 この API に含まれる認証設定のコレクション。
subscriptionKeyParameterNames オブジェクト サブスクリプション キーを含むクエリまたはヘッダー パラメーターのカスタム名を指定するために使用できる省略可能なプロパティ。 このプロパティが存在する場合は、次の 2 つのプロパティのうち少なくとも 1 つを含む必要があります。

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

API の概要

API summary エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
id ひも リソース識別子。 現在の API Management サービス インスタンス内の API を一意に識別します。 この値は、 apis/{id} の形式の有効な相対 URL です。ここで、 {id} は API 識別子です。 このプロパティは読み取り専用です。
name ひも API の名前。 空にしてはいけません。 最大長は 100 文字です。
description ひも API の説明。 空にしてはいけません。 HTML 書式設定タグを含めることができます。 最大長は 1000 文字です。

アプリケーション

application エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも アプリケーションの一意識別子。
Title ひも アプリケーションのタイトル。
Description ひも アプリケーションの説明。
Url URI（統一リソース識別子） アプリケーションの URI。
Version ひも アプリケーションのバージョン情報。
Requirements ひも アプリケーションの要件の説明。
State 数 アプリケーションの現在の状態。

- 0 - 登録済み

- 1 - 送信済み

- 2 - 発行済み

- 3 - 拒否

- 4 - 非公開
RegistrationDate 日付と時間 アプリケーションが登録された日付と時刻です。
CategoryId 数 アプリケーションのカテゴリ (財務、エンターテイメントなど)
DeveloperId ひも アプリケーションを提出した開発者の一意の識別子。
Attachments Attachment エンティティのコレクション。 スクリーンショットやアイコンなど、アプリケーションの添付ファイル。
Icon 添付 アプリケーションのアイコン。

添付ファイル

attachment エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
UniqueId ひも 添付ファイルにおける一意の識別子。
Url ひも リソースの URL。
Type ひも 添付ファイルの種類。
ContentType ひも 添付ファイルのメディアの種類。

コード サンプル

プロパティ タイプ 説明
title ひも 操作の名前。
snippet ひも このプロパティは非推奨であり、使用しないでください。
brush ひも コード サンプルを表示するときに使用するコード構文の色分けテンプレート。 使用できる値は、 plain、 php、 java、 xml、 objc、 python、 ruby、および csharpです。
template ひも このコード サンプル テンプレートの名前。
body ひも スニペットのコード サンプル部分のプレースホルダー。
method ひも 操作の HTTP メソッド。
scheme ひも 操作要求に使用するプロトコル。
path ひも 操作経路。
query ひも パラメーターが定義されたクエリ文字列の例。
host ひも この操作を含む API の API Management サービス ゲートウェイの URL。
headers ヘッダー エンティティのコレクション。 この操作のヘッダー。
parameters Parameter エンティティのコレクション。 この操作に定義されているパラメーター。

コメント

API エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id 数 コメントの ID。
CommentText ひも コメントの本文。 HTML を含めることができます。
DeveloperCompany ひも 開発者の会社名。
PostedOn 日付と時間 コメントが投稿された日時。

問題点

issue エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも 問題のユニークな識別子。
ApiID ひも この問題が報告された API の ID。
Title ひも 問題のタイトル。
Description ひも 問題の説明。
SubscriptionDeveloperName ひも 問題を報告した開発者の名。
IssueState ひも 問題の現在の状態。 使用可能な値は、提案中、オープン、クローズです。
ReportedOn 日付と時間 問題が報告された日時。
Comments Comment エンティティのコレクション。 この問題に関するコメント。
Attachments Attachment エンティティのコレクション。 問題に関するすべての添付ファイル。
Services API エンティティのコレクション。 問題を提出したユーザーがサブスクライブしている API。

フィルタリング

filtering エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Pattern ひも 現在の検索語句。検索語句がない場合は null します。
Placeholder ひも 検索語句が指定されていない場合に検索ボックスに表示するテキスト。

このセクションでは、 parameter 表現について説明します。

プロパティ タイプ 説明
name ひも パラメーター名。
description ひも パラメーターの説明。
value ひも ヘッダー値。
typeName ひも ヘッダー値のデータ型。
options ひも オプション。
required ブーリアン ヘッダーが必要かどうか。
readOnly ブーリアン ヘッダーが読み取り専用かどうか。

HTTP 要求

このセクションでは、 request 表現について説明します。

プロパティ タイプ 説明
description ひも 操作要求の説明。
headers ヘッダー エンティティの配列。 要求ヘッダー。
parameters パラメーターの配列 操作要求パラメーターのコレクション。
representations Representation の配列 操作要求表現のコレクション。

HTTP 応答

このセクションでは、 response 表現について説明します。

プロパティ タイプ 説明
statusCode 正の整数 操作応答状態コード。
description ひも 操作応答の説明。
representations Representation の配列 操作応答表現のコレクション。

操作

operation エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
id ひも リソース識別子。 現在の API Management サービス インスタンス内の操作を一意に識別します。 この値は、 apis/{aid}/operations/{id} の形式の有効な相対 URL です。ここで、 {aid} は API 識別子、 {id} は操作識別子です。 このプロパティは読み取り専用です。
name ひも オペレーション名。 空にしてはいけません。 最大長は 100 文字です。
description ひも 操作の説明。 空にしてはいけません。 HTML 書式設定タグを含めることができます。 最大長は 1000 文字です。
scheme ひも この API の操作を呼び出すことができるプロトコルについて説明します。 使用できる値は、 http、 https、または http と httpsの両方です。
uriTemplate ひも この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: customers/{cid}/orders/{oid}/?date={date}
host ひも API をホストする API Management ゲートウェイ URL。
httpMethod ひも HTTP メソッドの操作
request HTTP 要求 要求の詳細を含むエンティティ。
responses HTTP 応答の配列 操作 HTTP 応答 エンティティの配列。

operation menu エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
ApiId ひも 現在の API の ID。
CurrentOperationId ひも 現在の操作の ID。
Action ひも メニューの種類。
MenuItems 操作メニュー項目エンティティのコレクション。 現在の API の操作。

operation menu item エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも 操作の ID。
Title ひも 操作の説明。
HttpMethod ひも 操作の Http メソッド。

ページング

paging エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Page 数 現在のページ番号。
PageSize 数 1 ページに表示される最大結果。
TotalItemCount 数値 表示する項目の数。
ShowAll ブーリアン すべての結果を 1 ページに表示するかどうか。
PageCount 数字 結果のページ数。

パラメーター

このセクションでは、 parameter 表現について説明します。

プロパティ タイプ 説明
name ひも パラメーター名。
description ひも パラメーターの説明。
value ひも パラメーター値。
options 文字列の配列 クエリ パラメーターの値に対して定義された値。
required ブーリアン パラメーターが必要かどうかを指定します。
kind 数 このパラメーターがパス パラメーター (1) であるか、querystring パラメーター (2) であるか。
typeName ひも パラメーターの型。

プロダクト

product エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも リソース識別子。 現在の API Management サービス インスタンス内の製品を一意に識別します。 値は、products/{pid}が製品識別子である{pid}の形式の有効な相対 URL です。 このプロパティは読み取り専用です。
Title ひも 製品の名前。 空にしてはいけません。 最大長は 100 文字です。
Description ひも 製品の説明。 空にしてはいけません。 HTML 書式設定タグを含めることができます。 最大長は 1000 文字です。
Terms ひも 製品使用条件。 製品をサブスクライブしようとしている開発者は、サブスクリプション プロセスを完了する前に、これらの条件に同意する必要があります。
ProductState 数 製品を公開するかどうかを指定します。 公開された製品は、開発者ポータルで開発者が検出できます。 公開されていない製品は、管理者にのみ表示されます。

製品の状態に使用できる値は次のとおりです。

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions ブーリアン ユーザーがこの製品に対して複数のサブスクリプションを同時に持てることができるかどうかを指定します。
MultipleSubscriptionsCount 数 ユーザーが同時に持つことが許可されているこの製品のサブスクリプションの最大数。

プロバイダー

provider エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Properties 文字列ディクショナリ この認証プロバイダーのプロパティ。
AuthenticationType ひも プロバイダーの種類。 (Microsoft Entra ID、Facebook ログイン、Google アカウント、Microsoft アカウント、Twitter)。
Caption ひも プロバイダーの表示名。

表現

このセクションでは、 representationについて説明します。

プロパティ タイプ 説明
contentType ひも この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (たとえば、 application/xml) を指定します。
sample ひも 表現の例。

サブスクリプション

subscription エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも リソース識別子。 現在の API Management サービス インスタンス内のサブスクリプションを一意に識別します。 値は、subscriptions/{sid}がサブスクリプション識別子である{sid}の形式の有効な相対 URL です。 このプロパティは読み取り専用です。
ProductId ひも サブスクライブされている製品の製品リソース識別子。 値は、products/{pid}が製品識別子である{pid}の形式の有効な相対 URL です。
ProductTitle ひも 製品の名前。 空にしてはいけません。 最大長は 100 文字です。
ProductDescription ひも 製品の説明。 空にしてはいけません。 HTML 書式設定タグを含めることができます。 最大長は 1000 文字です。
ProductDetailsUrl ひも 製品の詳細への相対 URL。
state ひも サブスクリプションの状態。 次の状態があります。

- 0 - suspended – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。

- 1 - active – サブスクリプションがアクティブです。

- 2 - expired – サブスクリプションが有効期限に達し、非アクティブ化されました。

- 3 - submitted – サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。

- 4 - rejected – サブスクリプション要求が管理者によって拒否されました。

- 5 - cancelled – サブスクリプションが開発者または管理者によって取り消されました。
DisplayName ひも サブスクリプションの表示名。
CreatedDate 日時 サブスクリプションが作成された日付 (ISO 8601 形式: 2014-06-24T16:25:00Z)。
CanBeCancelled ブーリアン 現在のユーザーがサブスクリプションを取り消すことができるかどうか。
IsAwaitingApproval ブーリアン サブスクリプションが承認を待っているかどうか。
StartDate 日時 ISO 8601 形式のサブスクリプションの開始日: 2014-06-24T16:25:00Z。
ExpirationDate 日時 サブスクリプションの有効期限 (ISO 8601 形式: 2014-06-24T16:25:00Z)。
NotificationDate 日時 ISO 8601 形式のサブスクリプションの通知日: 2014-06-24T16:25:00Z。
primaryKey ひも プライマリ サブスクリプション キー。 最大長は 256 文字です。
secondaryKey ひも セカンダリ サブスクリプション キー。 最大長は 256 文字です。
CanBeRenewed ブーリアン 現在のユーザーがサブスクリプションを更新できるかどうか。
HasExpired ブーリアン サブスクリプションの有効期限が切れているかどうか。
IsRejected ブーリアン サブスクリプション要求が拒否されたかどうか。
CancelUrl ひも サブスクリプションを解約するための相対 URL。
RenewUrl ひも サブスクリプションを更新する相対 URL。

サブスクリプションの概要

subscription summary エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Id ひも リソース識別子。 現在の API Management サービス インスタンス内のサブスクリプションを一意に識別します。 値は、subscriptions/{sid}がサブスクリプション識別子である{sid}の形式の有効な相対 URL です。 このプロパティは読み取り専用です。
DisplayName ひも サブスクリプションの表示名

ユーザー アカウント情報

user account info エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
FirstName ひも 名前。 空にしてはいけません。 最大長は 100 文字です。
LastName ひも 名字。 空にしてはいけません。 最大長は 100 文字です。
Email ひも メール アドレスです。 空でなく、サービス インスタンス内で一意である必要があります。 最大長は 254 文字です。
Password ひも ユーザー アカウントのパスワード。
NameIdentifier ひも アカウント識別子。ユーザーの電子メールと同じです。
ProviderName ひも 認証プロバイダー名。
IsBasicAccount ブーリアン True の 場合、このアカウントは、電子メールとパスワードを使用して登録されました。アカウントがプロバイダーを使用して登録された場合は false。

ユーザー サインイン

user sign in エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
Email ひも メール アドレスです。 空でなく、サービス インスタンス内で一意である必要があります。 最大長は 254 文字です。
Password ひも ユーザー アカウントのパスワード。
ReturnUrl ひも ユーザーがサインインをクリックしたページの URL。
RememberMe ブーリアン 現在のユーザーの情報を保存するかどうか。
RegistrationEnabled ブーリアン 登録が有効かどうか。
DelegationEnabled ブーリアン 委任されたサインインが有効かどうか。
DelegationUrl ひも 委任されたサインイン URL (有効な場合)。
SsoSignUpUrl ひも ユーザーのシングル サインオン URL (存在する場合)。
AuxServiceUrl ひも 現在のユーザーが管理者の場合、これは Azure portal のサービス インスタンスへのリンクです。
Providers プロバイダー エンティティのコレクション このユーザーの認証プロバイダー。
UserRegistrationTerms ひも サインインする前にユーザーが同意する必要がある用語。
UserRegistrationTermsEnabled ブーリアン 用語が有効になっているかどうか。

ユーザーのサインアップ

user sign up エンティティには、次のプロパティがあります。

プロパティ タイプ 説明
PasswordConfirm ブーリアン サインアップサインアップ コントロールで使用される値。
Password ひも ユーザー アカウントのパスワード。
PasswordVerdictLevel 数 サインアップサインアップ コントロールで使用される値。
UserRegistrationTerms ひも サインインする前にユーザーが同意する必要がある用語。
UserRegistrationTermsOptions 数 サインアップサインアップ コントロールで使用される値。
ConsentAccepted ブーリアン サインアップサインアップ コントロールで使用される値。
Email ひも メール アドレスです。 空でなく、サービス インスタンス内で一意である必要があります。 最大長は 254 文字です。
FirstName ひも 名前。 空にしてはいけません。 最大長は 100 文字です。
LastName ひも 名字。 空にしてはいけません。 最大長は 100 文字です。
UserData ひも サインアップ コントロールによって使用される値。
NameIdentifier ひも サインアップサインアップ コントロールで使用される値。
ProviderName ひも 認証プロバイダー名。

次のステップ

テンプレートの操作方法の詳細については、テンプレートを使用して API Management 開発者ポータルをカスタマイズする方法に関するページを参照してください。