Azure App Service で Web ジョブを使用してバックグラウンド タスクを実行する
Azure portal を使用して、実行可能ファイルまたはスクリプトをアップロードするための WebJobs をデプロイします。 バックグラウンド タスクは、Azure App Service で実行できます。
Azure App Service の代わりに Visual Studio を使用して WebJobs を開発およびデプロイする場合は、Visual Studio を使用して WebJobs をデプロイするに関する記事を参照してください。
Note
Windows コンテナー、Linux コード、および Linux コンテナーの Web ジョブはプレビュー段階です。 Windows コード用の Web ジョブは一般公開されており、プレビュー段階ではありません。
概要
Web ジョブは、Web アプリと同じインスタンスでプログラムおよびスクリプトを実行できるようにする Azure App Service の機能です。 すべての App Service プランでは、WebJobs をサポートしています。 WebJobs を使用するための追加のコストはありません。
Note
2024 年 6 月 1 日より、新しく作成されたすべての App Service アプリには、名前付け規則 <app-name>-<random-hash>.<region>.azurewebsites.net を使用して一意の既定のホスト名を生成するオプションが備わります。 既存のアプリ名は変更されません。
例: myapp-ds27dh7271aah175.westus-01.azurewebsites.net
詳しくは、App Service リソースの一意の既定のホスト名に関する記事をご覧ください。
Azure WebJobs SDK と WebJobs を使用して、多くのプログラミング タスクを単純化できます。 詳細については、「 Azure Web ジョブ SDK とは」をご覧ください。
Azure Functions は、プログラムとスクリプトを実行する別の方法を提供します。 Web ジョブと Functions の比較については、「Flow、Logic Apps、Functions、WebJobs の比較」を参照してください。
Web ジョブの種類
スクリプトまたはプログラムでサポートされるファイルの種類
次のファイルの種類がサポートされます。
.cmd、.bat、.exe (Windows cmd を使用)
.ps1 (PowerShell を使用)
.sh (Bash を使用)
.js (Node.js を使用)
.jar (Java を使用)
これらのファイルの種類を実行するために必要なランタイムは、Web アプリ インスタンスに既にインストールされています。
継続的 Web ジョブとトリガーされる Web ジョブ
次の表で、継続的 Web ジョブとトリガーされる Web ジョブの違いを説明します。
| 継続的 | トリガー |
|---|---|
| Web ジョブが作成されるとすぐに開始します。 ジョブが終了しないようにするため、プログラムまたはスクリプトは、その動作を無限ループ内で実行します。 ジョブが終了した場合でも、再開することができます。 通常、WebJobs SDK と共に使用されます。 | 手動またはスケジュールに従ってトリガーされたときにのみ開始します。 |
| Web アプリが実行されているすべてのインスタンスで実行されます。 必要に応じて、Web ジョブを 1 つのインスタンスに制限できます。 | Azure が負荷分散用に選択した 1 つのインスタンス上で実行されます。 |
| リモート デバッグをサポートします。 | リモート デバッグをサポートしません。 |
コードは \site\wwwroot\app_data\Jobs\Continuous に配置されます。 |
コードは \site\wwwroot\app_data\Jobs\Triggered に配置されます。 |
Note
Web アプリは非アクティブな状態が 20 分続くとタイムアウトになり、実際の Web アプリに対する要求だけがタイマーをリセットできます。 Azure portal でアプリの構成を表示したり、高度なツールのサイト (https://<app_name>.scm.azurewebsites.net) に対して要求を行ったりしても、タイマーはリセットされません。 ジョブをホストしている Web アプリを継続的に実行させるか、またはスケジュールに従って実行させるか、あるいはイベント ドリブン トリガーを使用するように設定する場合は、Web アプリの Azure 構成ページで [常にオン] 設定を有効にします。 [常にオン] の設定は、これらの種類の WebJobs が確実に実行されるようにするのに役立ちます。 この機能は、Basic、Standard、および Premium の価格レベルでのみ利用できます。
継続的 Web ジョブを作成する
重要
アプリケーションでソース管理が構成されている場合は、ソース管理の統合の一環として Webjobs をデプロイする必要があります。 アプリケーションのソース管理を構成した後、WebJobs を Azure portal から追加することはできません。
Azure ポータルで、App Service Web アプリ、API アプリ、またはモバイル アプリの App Service ページに移動します。
左側のウィンドウで [WebJobs] を選択し、[追加] を選択します。
表で指定されている [Web ジョブの追加] 設定を入力し、[Web ジョブの作成] を選択します。
設定 値の例 説明 名前 myContinuousWebJob App Service アプリ内での一意の名前。 文字または数字で始まる必要があり、"-" と "_" 以外の特殊文字を使用することはできません。 ファイルのアップロード ConsoleApp.zip 実行可能ファイルまたはスクリプト ファイルと、プログラムまたはスクリプトを実行するために必要なサポート ファイルを含む .zip ファイル。 サポートされている実行可能ファイルまたはスクリプト ファイルの種類については、「サポートされるファイルの種類」セクションを参照してください。 種類 継続的 Web ジョブの種類については、この記事の中で既に説明しています。 スケール マルチインスタンス 継続的 Web ジョブでのみ使用できます。 プログラムまたはスクリプトがすべてのインスタンスで実行されるか、1 つのインスタンスだけで実行されるかどうかを決定します。 複数のインスタンスで実行するオプションは、Free または Shared 価格レベルには適用されません。 [Web ジョブ] ページに新しい Web ジョブが表示されます。 Web ジョブが追加されたというメッセージが表示されても、表示されない場合は、 [更新] を選択します。
継続的 Web ジョブを停止または再開するには、一覧でその Web ジョブを右クリックし、[停止] または [実行] ボタンを選択してから、選択内容を確認します。
手動でトリガーされる Web ジョブを作成する
Azure ポータルで、App Service Web アプリ、API アプリ、またはモバイル アプリの App Service ページに移動します。
左側のウィンドウで [WebJobs] を選択し、[追加] を選択します。
表で指定されている [Web ジョブの追加] 設定を入力し、[Web ジョブの作成] を選択します。
設定 値の例 説明 名前 myTriggeredWebJob App Service アプリ内での一意の名前。 文字または数字で始まる必要があり、"-" と "_" 以外の特殊文字を使用することはできません。 ファイルのアップロード ConsoleApp1.zip 実行可能ファイルまたはスクリプト ファイルと、プログラムまたはスクリプトを実行するために必要なサポート ファイルを含む .zip ファイル。 サポートされている実行可能ファイルまたはスクリプト ファイルの種類については、「サポートされるファイルの種類」セクションを参照してください。 種類 トリガー Web ジョブの種類については、この記事で前述のとおりです。 トリガー マニュアル [Web ジョブ] ページに新しい Web ジョブが表示されます。 Web ジョブが追加されたというメッセージが表示されても、表示されない場合は、 [更新] を選択します。
手動でトリガーされた Web ジョブを実行するには、一覧でその Web ジョブを右クリックし、[実行] ボタンを選択してから、選択内容を確認します。
スケジュールされた Web ジョブを作成する
スケジュールされた Web ジョブもトリガーされます。 指定するスケジュールでトリガーが自動的に実行されるように、スケジュール設定できます。
Azure ポータルで、App Service Web アプリ、API アプリ、またはモバイル アプリの App Service ページに移動します。
左側のウィンドウで [WebJobs] を選択し、[追加] を選択します。
表で指定されている [Web ジョブの追加] 設定を入力し、[Web ジョブの作成] を選択します。
設定 値の例 説明 名前 myScheduledWebJob App Service アプリ内での一意の名前。 文字または数字で始まる必要があり、"-" と "_" 以外の特殊文字を使用することはできません。 ファイルのアップロード ConsoleApp.zip 実行可能ファイルまたはスクリプト ファイルと、プログラムまたはスクリプトを実行するために必要なサポート ファイルを含む .zip ファイル。 サポートされている実行可能ファイルまたはスクリプト ファイルの種類については、「サポートされるファイルの種類」セクションを参照してください。 種類 トリガー Web ジョブの種類については、この記事の中で既に説明しています。 トリガー スケジュール スケジュールを確実に動作させるために、Always On 機能を有効にします。 Always On 機能は、Basic、Standard、および Premium の価格レベルでのみ利用できます。 CRON 式 0 0/20 * * * * CRON 式については、次のセクションで説明します。 [Web ジョブ] ページに新しい Web ジョブが表示されます。 Web ジョブが追加されたというメッセージが表示されても、表示されない場合は、 [更新] を選択します。
スケジュールされた Web ジョブは、CRON 式で定義されたスケジュールで実行されます。 任意のタイミングでこれを手動で実行するには、一覧でその Web ジョブを右クリックし、[実行] ボタンを選択してから、選択内容を確認します。
NCRONTAB 式
NCRONTAB 式は、ポータルで入力するか、settings.job ファイルを Web ジョブの .zip ファイルのルートに含めることができます。例を以下に示します。
{
"schedule": "0 */15 * * * *"
}
詳細については、「Scheduling a triggered WebJob (トリガーされる Web ジョブのスケジュール設定)」を参照してください。
Note
CRON 式の実行に使用される既定のタイム ゾーンは、協定世界時 (UTC) です。 別のタイム ゾーンに基づいて CRON 式を実行するには、ご使用の関数アプリ用に WEBSITE_TIME_ZONE という名前のアプリ設定を作成します。 詳細については、「NCRONTAB タイムゾーン」を参照してください。
Web ジョブの管理
Azure portal で、サイトで実行されている個々の Web ジョブの実行状態を管理できます。 [設定]>[Web ジョブ] にアクセスし、Web ジョブを選択すると、Web ジョブを開始および停止することができます。 また、Web ジョブを実行する Webhook のパスワードを表示および変更することもできます。
また、1 という値を持つ WEBJOBS_STOPPED という名前のアプリケーション設定を追加して、サイトで実行されているすべての Web ジョブを停止することもできます。 この方法を使用すると、ステージングおよび運用スロットの両方で競合する Web ジョブが実行されないようにすることができます。 同様に、1 の値を WEBJOBS_DISABLE_SCHEDULE 設定に使用して、サイトまたはステージング スロットでトリガーされた Web ジョブを無効にすることもできます。 スロットの場合は、設定自体がスワップされないように、 [デプロイ スロットの設定] オプションを必ず有効にしてください。
ジョブ履歴の表示
表示する Web ジョブで、[ログ] を選択します。
[WebJob Details](Web ジョブの詳細) ページで、詳細を確認する実行時間を選択します。
[Web ジョブ実行の詳細] ページでは、[ダウンロード] を選択してログのテキスト ファイルを取得するか、ページの上部にある [WebJobs] 階層リンクを選択して別の Web ジョブのログを表示できます。
Web ジョブの状態
一般的な Web ジョブの状態の一覧を次に示します。
- 初期化 アプリは開始されたばかりで、Web ジョブでは初期化プロセスが実行されています。
- Starting Web ジョブを開始しています。
- Running Web ジョブの実行中です。
- PendingRestart 継続的 Web ジョブは、何らかの理由で開始されてから 2 分未満で終了し、App Service では 60 秒待ってから Web ジョブを再起動します。 2 分後に継続的 Web ジョブが終了した場合、App Service では 60 秒間待機せず、Web ジョブを直ちに再起動します。
- Stopped Web ジョブは (通常は Azure portal から) 停止され、現在は実行されておらず、継続的またはスケジュールされた Web ジョブであっても、手動で再度開始するまで実行されません。
- 中止 これは、実行時間の長い Web ジョブがタイムアウト マーカーに達した場合など、多くの理由で発生する可能性があります。
次のステップ
Azure WebJobs SDK と Web ジョブを使用して、多くのプログラミング タスクを単純化できます。 詳細については、「 Azure Web ジョブ SDK とは」をご覧ください。