Windows Azure Pack 網站服務 REST API
適用于：Windows Azure Pack
本檔說明如何使用 Windows Azure Pack Web Sites 管理 REST API，在網站中執行一般工作。
概觀
Windows Azure Pack Web Sites 管理 API 提供一組 RESTful Web 服務，可與 Windows Azure Pack Web Sites 服務互動，以管理您的網站。 API 具有實體，可擷取終端使用者與Windows Azure Pack Web Sites 服務之間的關聯性。
網站管理 API 可啟用一組核心的網站管理案例：
建立、刪除及設定網站。
查詢網站的狀態。
查詢度量，例如資源使用量、配額和限制。
擷取中繼資料，例如發佈設定檔。
設定網站的規模。
使用者
Windows Azure Pack Web Sites 管理 REST API 的終端使用者有兩個主要類別：
網站管理員會在Windows Azure Pack 網站中建立和管理網站及補充資源。 此角色對應至 azure Pack 訂用帳戶的系統管理員或共同管理員Windows。
Publisher會存取網站的內容，並使用 FTP 或 WebDeploy 等通訊協定發佈內容。 從主控提供者的觀點來看，發行者就是 FTP 使用者。 發行者無法對網站執行管理動作。
資源
Windows Azure 網站 REST API 公開下列資源階層，以管理您的服務及部署：
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
下表描述上述資源。
資源 |
描述 |
|---|---|
訂用帳戶 |
Windows Azure Pack 訂用帳戶，需要使用Windows Azure 網站。 |
Webspaces |
Webspace，這是邏輯實體，與指定地理區域中使用者的訂用帳戶相關聯。 給定地區內的所有網站皆與給定的網路空間相關聯。 |
網站 |
這是Windows Azure Web Sites 服務提供的核心資源實體網站。 |
Config |
資源，包含月臺組態屬性，例如 AppSettings、 ConnectionStrings、 ErrorLogging和 FrameworkVersions。 |
Publishxml |
XML 格式的檔案，其中包含將 Web 應用程式發佈至 Azure 網站Windows的使用者設定。 此檔案可以匯入並用於Microsoft Visual Studio或 Web 矩陣。 |
使用方式 |
資源，包含目前網站使用量的相關資訊。 |
計量 |
資源，其中包含有關使用量之報表中的歷程記錄資訊。 |
存放庫 |
與月臺相關聯的原始檔控制管理存放庫。 |
Serverfarm |
一組電腦，這些電腦會保留給指定區域中特定租使用者的裝載網站。 目前，每個資料中心只支援一個伺服器陣列。 |
資源上的作業
建立資源
您可以使用 HTTP POST 動詞命令建立新資源。 資源名稱是透過要求主體傳遞。 如果成功建立資源，則會傳回 HTTP 201 狀態碼，且序列化的資源物件會包含在回應主體中。 如果用戶端嘗試建立已經存在的資源，則會傳回 HTTP 409 衝突狀態碼。
讀取資源
若要讀取現有資源的目前狀態，請使用 HTTP GET 動詞命令。 如果資源存在，則回應狀態碼為 200，而回應本文包含序列化物件。 如果資源不存在，則回應狀態碼為 404，找不到資源。
更新資源
您可以使用 HTTP PUT 動詞命令更新現有的資源。 此物件的名稱會在 URL 字串中傳遞，且物件的新狀態會在要求主體中傳遞。 如果成功更新資源，將傳回 HTTP 200 狀態碼。 若所更新的資源不存在，則會傳回 HTTP 404 (找不到) 狀態碼。
刪除資源
您可以使用 HTTP DELETE 動詞命令刪除現有的資源。 物件的名稱會在 URL 字串中傳遞。 如果成功刪除資源，將傳回 HTTP 200 狀態碼。 若物件已遭到刪除或不存在，則會傳回 HTTP 404。
API 版本設定
如同Windows Azure 服務，Windows Azure Pack Web Sites 遵循Windows Azure REST API 版本設定。 Windows Azure Pack Web Sites REST API 所提供的作業有多個版本。 您必須藉由設定 x-ms-version 要求標頭來指定要使用的作業版本。 沒有 x-ms-version 標頭的要求會遭到拒絕，並傳回 (400) 不正確的要求回應。 如果您的服務呼叫舊版的作業，且存在較新版本，您可以選擇繼續呼叫舊版，或繼續修改程式碼以呼叫較新版本。
注意
雖然 API 版本可能會變更，Windows Azure Pack Web Sites 同時支援較新的 API 版本和先前的版本。
x-ms-version 要求標頭值必須以 YYYY-MM-DD 格式指定。 程式碼範例會顯示必要的格式。
要求標頭：
x-ms-version： 2012-10-10