共用方式為

Azure API 管理範本數據模型參考

本主題描述在 Azure API 管理中，開發人員門戶範本的資料模型中常用項目的實體和類型表示。

如需使用範本的詳細資訊，請參閱 如何使用範本自定義 API 管理開發人員入口網站。

備註

下列檔內容與已淘汰的開發人員入口網站有關。 您可以照舊繼續使用，直到其在 2023 年 10 月淘汰，屆時便會將其從所有 API 管理服務中移除。 已被取代的入口網站只會接收重要的安全性更新。 如需詳細資訊，請參閱下列文章：

適用於：開發人員 | 基本 | 標準 | 進階

參考文獻

API（應用程式介面）

API 實體具有下列屬性：

財產 類型 說明
id 字串 資源標識碼。 可唯一識別目前 API 管理服務實例內的 API。 值是 apis/{id} 格式的有效相對 URL，其中 {id} 是 API 識別符。 這個屬性是唯讀的。
name 字串 API 的名稱。 不得為空白。 長度上限為 100 個字元。
description 字串 API 的描述。 不得為空白。 可能包含 HTML 格式標記。 長度上限為 1000 個字元。
serviceUrl 字串 提供此 API 的後端服務的絕對 URL。
path 字串 相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。
protocols 數字的陣列 描述可以叫用此 API 中作業的通訊協定。 允許的值為 1 - http 和 2 - https，或兩者。
authenticationSettings 授權伺服器驗證設定 此 API 中包含的驗證設定集合。
subscriptionKeyParameterNames 物體 選擇性屬性，可用來指定包含訂用帳戶密鑰之查詢和/或標頭參數的自定義名稱。 當這個屬性存在時，它至少必須包含下列兩個屬性的其中一個。

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

API 摘要

API summary 實體具有下列屬性：

財產 類型 說明
id 字串 資源標識碼。 可唯一識別目前 API 管理服務實例內的 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 集合 附件 的實體。 應用程式的任何附件，例如螢幕快照或圖示。
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 管理服務閘道 URL。
headers 標頭 實體的集合體。 這項作業的標題。
parameters 參數 實體的集合。 為此作業定義的參數。

評論

API 實體具有下列屬性：

財產 類型 說明
Id 數字 評論的ID。
CommentText 字串 批注的內容。 可能包含 HTML。
DeveloperCompany 字串 開發人員的公司名稱。
PostedOn 日期時間 張貼批注的日期和時間。

問題

issue 實體具有下列屬性。

財產 類型 說明
Id 字串 問題的唯一標識碼。
ApiID 字串 回報此問題之 API 的識別碼。
Title 字串 問題的標題。
Description 字串 問題的描述。
SubscriptionDeveloperName 字串 回報問題的開發人員名字。
IssueState 字串 問題的目前狀態。 可能的值為 Proposed、Opened、Closed。
ReportedOn 日期時間 回報問題的日期和時間。
Comments 批注 實體的集合。 此問題的批注。
Attachments 集合 附件 的實體。 與該問題相關的附件。
Services API 實體的集合。 提交問題的使用者所訂閱的 API。

篩選

filtering 實體具有下列屬性：

財產 類型 說明
Pattern 字串 目前的搜尋字詞;如果沒有搜尋字詞，則為 null。
Placeholder 字串 未指定搜尋字詞時，要顯示在搜尋方塊中的文字。

本節說明 parameter 表示法。

財產 類型 說明
name 字串 參數名稱。
description 字串 參數描述。
value 字串 標頭值。
typeName 字串 標頭值的數據類型。
options 字串 選項。
required 布爾值 是否需要標題。
readOnly 布爾值 標頭是否為唯讀。

HTTP 要求

本節說明 request 表示法。

財產 類型 說明
description 字串 作業要求描述。
headers 標頭 實體的陣列。 要求標頭。
parameters 的參數 的陣列 作業要求參數的集合。
representations 表示法 陣列 操作請求表示的集合。

HTTP 回應

本節說明 response 表示法。

財產 類型 說明
statusCode 正整數 作業回應狀態代碼。
description 字串 作業回應描述。
representations 表示法 陣列 作業回應表示的集合。

行動

operation 實體具有下列屬性：

財產 類型 說明
id 字串 資源標識碼。 唯一識別目前 API 管理服務實例內的作業。 值是 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 管理閘道 URL。
httpMethod 字串 作業 HTTP 方法。
request HTTP 要求 包含請求詳細信息的實體。
responses HTTP 回應 的陣列 作業操作陣列 HTTP 回應 實體。

operation menu 實體具有下列屬性：

財產 類型 說明
ApiId 字串 目前 API 的識別碼。
CurrentOperationId 字串 目前作業的ID。
Action 字串 功能表類型。
MenuItems 作業選單項目 實體的集合。 目前 API 的操作。

operation menu item 實體具有下列屬性：

財產 類型 說明
Id 字串 作業的標識碼。
Title 字串 作業的描述。
HttpMethod 字串 作業的HTTP方法。

尋呼

paging 實體具有下列屬性：

財產 類型 說明
Page 數字 目前的頁碼。
PageSize 數字 單頁面上要顯示的最大結果數量。
TotalItemCount 數字 要顯示的項目數。
ShowAll 布爾值 是否要在單一頁面上顯示所有結果。
PageCount 數字 結果的頁數。

參數

本節說明 parameter 表示法。

財產 類型 說明
name 字串 參數名稱。
description 字串 參數描述。
value 字串 參數值。
options 字串陣列 針對查詢參數值定義的值。
required 布爾值 指定參數是否為必要的配置。
kind 數字 這個參數是路徑參數 （1），還是 querystring 參數 （2）。
typeName 字串 參數類型。

產品

product 實體具有下列屬性：

財產 類型 說明
Id 字串 資源標識碼。 可唯一識別目前 API 管理服務實例內的產品。 值是 products/{pid} 格式的有效相對 URL，其中 {pid} 是產品識別碼。 這個屬性是唯讀的。
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 管理服務實例內的訂用帳戶。 值是以 subscriptions/{sid} 格式的有效相對 URL，其中 {sid} 是訂用帳戶標識碼。 這個屬性是唯讀的。
ProductId 字串 已訂閱產品的產品資源標識碼。 值是 products/{pid} 格式的有效相對 URL，其中 {pid} 是產品識別碼。
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 字串 用來取消訂閱的相對網址。
RenewUrl 字串 更新訂閱的相對網址。

訂閱摘要

subscription summary 實體具有下列屬性：

財產 類型 說明
Id 字串 資源標識碼。 可唯一識別目前 API 管理服務實例內的訂用帳戶。 值是以 subscriptions/{sid} 格式的有效相對 URL，其中 {sid} 是訂用帳戶標識碼。 這個屬性是唯讀的。
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 入口網站中服務實例的連結。
Providers 提供者 實體的集合 此用戶的驗證提供者。
UserRegistrationTerms 字串 使用者在登入之前必須同意的條款。
UserRegistrationTermsEnabled 布爾值 是否啟用詞彙。

用戶註冊

user sign up 實體具有下列屬性：

財產 類型 說明
PasswordConfirm 布爾值 註冊註冊控件所使用的值。
Password 字串 用戶帳戶密碼。
PasswordVerdictLevel 數字 註冊註冊控件所使用的值。
UserRegistrationTerms 字串 使用者在登入之前必須同意的條款。
UserRegistrationTermsOptions 數字 註冊註冊控件所使用的值。
ConsentAccepted 布爾值 註冊註冊控件所使用的值。
Email 字串 電子郵件地址。 不能是空的，而且在服務實例內必須是唯一的。 長度上限為 254 個字元。
FirstName 字串 名字。 不得為空白。 長度上限為 100 個字元。
LastName 字串 姓。 不得為空白。 長度上限為 100 個字元。
UserData 字串 註冊 控件所使用的值。
NameIdentifier 字串 註冊註冊控件所使用的值。
ProviderName 字串 驗證提供者名稱。

後續步驟

如需使用範本的詳細資訊，請參閱 如何使用範本自定義 API 管理開發人員入口網站。

  • Last updated on