Azure Pack Websites Service REST API のWindows
適用対象: Azure Pack Windows
このドキュメントでは、Windows Azure Pack Web サイト管理 REST API を使用して Web サイトで一般的なタスクを実行する方法について説明します。
概要
Windows Azure Pack Web サイト管理 API は、Web サイトを管理するために、Windows Azure Pack Web サイト サービスとやり取りする RESTful 一連の Web サービスを提供します。 API には、エンド ユーザーと azure Pack Web サイト サービスWindows間の関係をキャプチャするエンティティがあります。
Web サイト管理 API を使用すると、サイト管理シナリオのコア セットを使用できます。
Web サイトを作成、削除、構成します。
Web サイトの状態を照会します。
リソース使用量、クォータ、制限などのメトリックについてクエリを実行します。
発行プロファイルなどのメタデータを取得します。
Web サイトの規模を構成します。
エンド ユーザー
Windows Azure Pack Web Sites Management REST API のエンド ユーザーには、主に 2 つのカテゴリがあります。
Web サイト管理者は、Windows Azure Pack Web サイトでサイトと補足リソースを作成および管理します。 このロールは、Azure Pack サブスクリプションの管理者または共同管理者Windowsに対応します。
Publisherは、FTP や WebDeploy などのプロトコルを使用してサイトのコンテンツにアクセスし、コンテンツを発行します。 ホスティング プロバイダーから見ると、発行者は FTP ユーザーです。 発行者はサイトの管理操作を実行できません。
リソース
Windows Azure の Web サイト REST API によって、サービスと展開を管理するための次のリソース階層が公開されます。
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
次の表では、上記のリソースについて説明します。
リソース |
説明 |
|---|---|
サブスクリプション |
Windows Azure Web サイトの使用に必要な azure Pack サブスクリプションWindows。 |
Web スペース |
特定の地理的リージョンのユーザーのサブスクリプションに関連付けられている論理エンティティである Web スペース。 特定地域のすべてのサイトは、特定の Web スペースの関連付けです。 |
サイト |
Windows Azure Web Sites サービスによって提供されるコア リソース エンティティであるサイト。 |
構成 |
AppSettings、ConnectionStrings、ErrorLogging、FrameworkVersions などのサイト構成プロパティを含むリソース。 |
Publishxml |
Azure Web サイトに Web アプリケーションを発行するためのユーザーの設定を含む XML 形式Windowsファイル。 このファイルは、Microsoft Visual Studioまたは Web マトリックスにインポートして使用できます。 |
使用法 |
現在の Web サイトの使用状況に関する情報を含むリソース。 |
メトリック |
使用状況に関するレポートに履歴情報を含むリソース。 |
リポジトリ |
サイトに関連付けられているソース管理リポジトリ。 |
Serverfarm |
特定のリージョン内の特定のテナントのサイトをホストするために予約されている一連のコンピューター。 現時点では、データ センターごとに 1 つのサーバー ファームのみがサポートされています。 |
リソースに対する操作
リソースの作成
新しいリソースは、HTTP POST 動詞によって作成されます。 リソース名は要求本文で渡されます。 リソースが正常に作成されると、HTTP 201 状態コードが返され、シリアル化されたリソース オブジェクトが応答本文に含まれます。 クライアントが既に存在するリソースを作成しようとすると、HTTP 409 競合状態コードが返されます。
リソースの読み取り
既存のリソースの現在の状態を読み取るには、HTTP GET 動詞を使用します。 リソースが存在する場合、応答状態コードは 200 で、応答本文にはシリアル化されたオブジェクトが含まれます。 リソースが存在しない場合、応答状態コードは 404 で、リソースが見つかりませんでした。
リソースの更新
既存のリソースは、HTTP PUT 動詞によって更新されます。 オブジェクトの名前が URL 文字列で渡され、オブジェクトの新しい状態が要求本文で渡されます。 リソースが正常に更新された場合、ステータス コード HTTP 200 が返されます。 更新するリソースが存在しない場合、ステータス コード HTTP 404 (Not Found) が返されます。
リソースの削除
既存のリソースは、HTTP DELETE 動詞によって削除されます。 オブジェクトの名前は URL 文字列で渡されます。 リソースが正常に削除された場合、ステータス コード HTTP 200 が返されます。 オブジェクトが既に削除されているか存在しない場合は、HTTP 404 が返されます。
API のバージョン管理
Windows Azure サービスと同様に、Azure Pack Web サイトWindowsは、Azure REST API のバージョン管理Windows準拠しています。 Windows Azure Pack Web サイト REST API によって提供される操作には、複数のバージョンがあります。 x-ms-version 要求ヘッダーを設定して、使用する操作のバージョンを指定する必要があります。 x-ms-version ヘッダーのない要求は拒否され、(400) 無効な要求応答が返されます。 サービスが以前のバージョンの操作を呼び出し、新しいバージョンが存在する場合は、以前のバージョンの呼び出しを続行するか、新しいバージョンを呼び出すコードの変更を続行するかを選択できます。
注意
API のバージョンは変更される可能性がありますが、Windows Azure Pack Web サイトでは、新しい API バージョンと直前のバージョンの両方がサポートされます。
x-ms-version 要求ヘッダー値は、YYYY-MM-DD 形式で指定する必要があります。 コード例は、必要な形式を示しています。
要求ヘッダー:
x-ms-version: 2012-10-10