エクスポート (0) 印刷
すべて展開

スケジューラ REST API リファレンス

更新日: 2013年10月

このトピックでは、スケジューラ管理 REST API を使用して Azure スケジューラで一般的なタスクを実行する方法について説明します。

  • 有効な Azure アカウントとアクティブな Azure サブスクリプションが必要です。このドキュメントは、アクティブなサブスクリプションおよび関連するサブスクリプション ID を既に所有していることを前提としています。

  • Azure サブスクリプションの管理証明書。サブスクリプション内のリソースへのクライアント アクセスを認証するために、管理証明書が必要です。公開キーを含み、.cer ファイル名の拡張子を持つ X-509 v3 証明書を使用する必要があります。管理証明書の作成方法の詳細については、「Azure での証明書の管理」を参照してください。

スケジューラ API は、Azure スケジューラ サービスとやり取りして、スケジュールされたジョブやジョブ コレクションを管理する操作の RESTful セットを提供します。

スケジューラ管理 API を使用すると、主要な一連のサイト管理シナリオを実現できます。

  1. "ジョブ コレクション" をプログラムで作成、更新、削除する。

  2. スケジュールされたジョブをプログラムで作成、更新、削除する。

  3. ジョブ コレクションとジョブの一覧をプログラムで表示する。

  4. ジョブの状態と履歴をプログラムで表示する。

Azure スケジューラ REST API によって、ジョブとジョブ コレクションを管理するための次のリソース階層が公開されます。

/cloudservices

   /jobcollections

      /jobs

         /history

サービスで要求の処理が終了したかどうかを確認するには、Get Operation Status を呼び出します。特に、リソースを後続の呼び出しで使用する場合や、変更や削除が実際に行われたかどうかを確認する場合は、この操作を呼び出してください。非同期操作の詳細については、「非同期サービス管理要求の追跡」を参照してください。

新しいリソースは、HTTP POST 動詞または PUT 動詞によって作成されます。リソースが正常に作成された場合、ステータス コード HTTP 200 (OK)、201 (Created)、または 202 (Accepted) が返され、シリアル化されたリソース オブジェクトが応答本文に含まれます。クライアントが既に存在するリソースを作成しようとすると、ステータス コード HTTP 400 (Bad Request) または 409 (Conflict) が返されます。

既存のリソースの現在の状態を読み取るには、HTTP GET 動詞を使用します。リソースが存在する場合、応答のステータス コードは 200 または 202 になり、応答本文にはシリアル化されたオブジェクトが含まれます。リソースが存在しない場合、応答のステータス コードは 400 (Bad Request) または 404 (Not Found) になります。

既存のリソースは、HTTP PUT 動詞または PATCH 動詞によって更新されます。オブジェクトの名前が URL 文字列で渡され、オブジェクトの新しい状態が要求本文で渡されます。リソースが正常に更新された場合、ステータス コード HTTP 200 または 202 が返されます。更新するリソースが存在しない場合、ステータス コード 400 (Bad Request) または 404 (Not Found) が返されます。

既存のリソースは、HTTP DELETE 動詞によって削除されます。オブジェクトの名前は URL 文字列で渡されます。リソースが正常に削除された場合、ステータス コード HTTP 200 または 202 が返されます。オブジェクトが既に削除されているか存在しない場合は、HTTP 400 または 404 が返されます。

Azure スケジューラ API を正常に呼び出すには、サブスクリプションに関連付けられている管理証明書が必要です。詳細については、「サービス管理要求の認証」を参照してください。スケジューラ サービス エンドポイントは https のみを介して公開されるので、情報公開の脅威を軽減することができます。

表示:
© 2014 Microsoft