Visual Studioを使用した Web ジョブの開発とデプロイ

この記事では、Visual Studioを使用して、コンソール アプリ プロジェクトを Azure App ServiceAzure WebJob として Web アプリにデプロイする方法について説明します。 Azure ポータルを使用して Web ジョブをデプロイする方法については、「Run background tasks with WebJobs in Azure App Service」を参照してください。

.NET Core アプリまたは .NET Framework アプリとして実行される Web ジョブを開発できます。 Azure WebJobs SDK のバージョン 3.x では、.NET Core アプリまたは .NET Framework アプリとして実行される Web ジョブを開発できますが、バージョン 2.x では .NET Framework のみがサポートされます。 WebJobs プロジェクトをデプロイする方法は、.NET Core プロジェクトの場合と、.NET Framework プロジェクトの場合とは異なります。

Web アプリ内の各 Web ジョブに一意の名前が付いている場合は、複数の Web ジョブを 1 つの Web アプリに発行できます。

.NET Core コンソール アプリとしての Web ジョブ

Azure WebJobs SDK のバージョン 3.x を使用すると、Web ジョブを作成し、コア コンソール アプリとして.NET発行できます。 .NET Core コンソール アプリを作成して Web ジョブとしてAzureに発行する手順については、「Get started with the Azure WebJobs SDK for event-driven background processingを参照してください。

Azure App Serviceにデプロイする

Visual StudioからAzure App Serviceに .NET Core WebJob を発行するには、ASP.NET Core アプリの発行と同じツールを使用します。

1. Solution Explorer でプロジェクトを右クリックし、Publish を選択します。

2. Publish ダイアログ ボックスで、Target の Azure を選択し、 Next を選択します。

3. Specific target の Azure WebJobs を選択し、 Next を選択します。

4. App Service インスタンスの上でプラス (+) ボタンを選択して、新しい Azure WebJob を作成します。

5. App Service (Windows) ダイアログ ボックスで、次の表のホスティング設定を使用します。

   設定	推奨値	説明
   名前	グローバルに一意の名前	新しい関数アプリを一意に識別する名前。
   サブスクリプション	サブスクリプションを選択する	使用するAzure サブスクリプション。
   リソース グループ	マイリソースグループ	関数アプリを作成するリソース グループの名前。 [ 新規 ] を選択して新しいリソース グループを作成します。
   ホスティング プラン	App Service プラン	App Service プランは、アプリのホストとなる Web サーバー ファームの場所、サイズ、機能を規定します。 1 つの App Service プランを共有するように Web アプリを構成することで、複数のアプリをホストするときのコストを抑えることができます。 App Service プランでは、リージョン、インスタンス サイズ、スケール数、および SKU (Free、Shared、Basic、Standard、または Premium) を定義します。 [新規] を選択して、新しい App Service プランを作成します。 Free レベルと Basic レベルでは、サイトを継続的に実行する [Always On] オプションはサポートされていません。

   

6. Create を選択して、これらの設定をAzureに Web ジョブと関連リソースを作成し、プロジェクト コードを配置します。

7. [完了] を選択して [発行] ページに戻ります。

.NET Framework コンソール アプリとしての Web ジョブ

Visual Studioを使用して WebJobs 対応.NET Framework コンソール アプリ プロジェクトをデプロイする場合、ランタイム ファイルは Web アプリ内の適切なフォルダー (App_Data/jobs/continuous (継続的 Web ジョブの場合) にコピーされ、スケジュールされた Web ジョブまたはオンデマンド Web ジョブの場合は App_Data/jobs/triggered)。

Visual Studioは、WebJobs 対応プロジェクトに次の項目を追加します。

• Microsoft。Web.WebJobs.Publish NuGet パッケージ。
• 展開とスケジューラの設定を含む webjob-publish-settings.json ファイル。

これらの項目を既存のコンソール アプリ プロジェクトに追加することも、テンプレートを使用して新しい WebJobs 対応コンソール アプリ プロジェクトを作成することもできます。

プロジェクトを単独で Web ジョブとして配置するか、Web プロジェクトにリンクして、Web プロジェクトを配置するたびに自動的に配置されるようにします。 プロジェクトをリンクするには、Visual Studio Web ジョブが有効なプロジェクトの名前を Web プロジェクトの webjobs-list.json ファイルに含めます。

[前提条件]

Azure開発ワークロードと共にVisual Studio 2022 をインストールします。

既存のコンソール アプリ プロジェクトの WebJobs デプロイを有効にする

次の 2 つのオプションがあります。

• Web プロジェクトで自動配置を有効にします。

  Web プロジェクトをデプロイするときに Web ジョブとして自動的にデプロイされるように、既存のコンソール アプリ プロジェクトを構成します。 このオプションは、関連する Web アプリケーションを実行するのと同じ Web アプリで Web ジョブを実行する場合に使用します。

• Web プロジェクトを使用せずに配置を有効にします。

  Web プロジェクトへのリンクを使用せずに、既存のコンソール アプリ プロジェクトを Web ジョブとして単独でデプロイするように構成します。 このオプションは、Web アプリ内で Web アプリケーションが実行されていない状態で、Web アプリ内で単独で Web ジョブを実行する場合に使用します。 Web アプリケーション リソースとは別に Web ジョブ リソースをスケーリングする場合に使用できます。

Web プロジェクトで Web ジョブの自動デプロイを有効にする

1. Solution Explorer で Webプロジェクトを右クリックし、追加>して既存のプロジェクトを Azure WebJob として追加を選択します。

   

   Azure WebJob 追加 ダイアログ ボックスが表示されます。

2. Project name ドロップダウン リストで、Web ジョブとして追加するコンソール アプリのprojectを選択します。

   

3. Azure Web ジョブの追加ダイアログ ボックスに入力し、OK を選択します。

Web プロジェクトを使用せずに Web ジョブのデプロイを有効にする

1. Solution Explorer でコンソール アプリ プロジェクトを右クリックし、 WebJob Azure として発行を選択します。

   

   [Azure Web ジョブの追加] ダイアログ ボックスが表示され、 [プロジェクト名] ボックスに選択されたプロジェクトが示されます。

2. Azure Web ジョブの追加ダイアログ ボックスに入力し、OK を選択します。

   Web パブリッシュウィザードが表示されます。 すぐに発行しない場合は、ウィザードを閉じます。 入力した設定は、 プロジェクトを配置する場合に保存されます。

新しい WebJobs 対応プロジェクトを作成する

新しい WebJobs 対応プロジェクトを作成するには、コンソール アプリ プロジェクト テンプレートを使用し、 前のセクションで説明したように WebJobs のデプロイを有効にします。 別の方法として、WebJobs new-project テンプレートを使用できます。

• 独立した Web ジョブを作成するために、WebJobs の新規プロジェクト テンプレートを使用する

  プロジェクトを作成し、Web プロジェクトへのリンクなしで、単独で Web ジョブとしてデプロイするように構成します。 このオプションは、Web アプリ内で Web アプリケーションが実行されていない状態で、Web アプリ内で単独で Web ジョブを実行する場合に使用します。 Web アプリケーション リソースとは別に Web ジョブ リソースをスケーリングする場合に使用できます。

• Web プロジェクトにリンクされた Web ジョブには、WebJobs の「new-project」テンプレートを使用する

  Web プロジェクトを同じソリューションに配置するときに、Web ジョブとして自動的に配置するように構成されたプロジェクトを作成します。 このオプションは、関連する Web アプリケーションを実行するのと同じ Web アプリで Web ジョブを実行する場合に使用します。

独立した Web ジョブに WebJobs new-project テンプレートを使用する

1. File>New>Project を選択します。 [新しいプロジェクトの作成] ダイアログ ボックスで、C# Azure WebJob (.NET Framework) を検索して選択します。

2. 前の手順に従って、 コンソール アプリ プロジェクトを独立した Web ジョブ プロジェクトにします。

Web プロジェクトにリンクされた Web ジョブ用に Web ジョブの新しいプロジェクト テンプレートを使用する

1. Solution Explorer で Web projectを右クリックし、 Add>New Azure WebJob Project を選択します。

   

   Azure WebJob 追加 ダイアログ ボックスが表示されます。

2. Azure Web ジョブの追加ダイアログ ボックスに入力し、OK を選択します。

webjob-publish-settings.json ファイル

Web ジョブのデプロイ用にコンソール アプリを構成すると、Visual Studioは Microsoft をインストールします。Web.WebJobs.Publish NuGet パッケージとスケジュール情報は、WebJobs プロジェクトのプロジェクト Properties フォルダーの webjob-publish-settings.json ファイルに格納されます。 そのファイルの例を次に示します。

{
  "$schema": "http://schemastore.org/schemas/json/webjob-publish-settings.json",
  "webJobName": "WebJob1",
  "startTime": "null",
  "endTime": "null",
  "jobRecurrenceFrequency": "null",
  "interval": null,
  "runMode": "Continuous"
}

このファイルは直接編集でき、Visual StudioはIntelliSenseを提供します。 ファイル スキーマは https://schemastore.org に格納され、そこで表示できます。

webjobs-list.json ファイル

WebJobs 対応プロジェクトを Web プロジェクトにリンクすると、Visual Studioは Web ジョブ プロジェクトの名前を web プロジェクトの Properties フォルダーの webjobs-list.json ファイルに格納します。 次の例に示すように、リストには複数の WebJobs プロジェクトが含まれている場合があります。

{
  "$schema": "http://schemastore.org/schemas/json/webjobs-list.json",
  "WebJobs": [
    {
      "filePath": "../ConsoleApplication1/ConsoleApplication1.csproj"
    },
    {
      "filePath": "../WebJob1/WebJob1.csproj"
    }
  ]
}

IntelliSense を使用して、Visual Studioでこのファイルを直接編集できます。 ファイル スキーマは、 https://schemastore.orgに格納されます。

WebJobs プロジェクトをデプロイする

Web プロジェクトにリンクする Web ジョブ プロジェクトは、Web プロジェクトと共に自動的に配置されます。 Web プロジェクトのデプロイの詳細については、「ハウツー ガイド>左側のナビゲーションでアプリをデプロイする」を参照してください。

WebJobs プロジェクトを単独で配置するには、Solution Explorer でプロジェクトを右クリックし、WebJob。

独立した Web ジョブの場合、Web プロジェクトに使用されるのと同じ Web 発行 ウィザードが表示されますが、変更できる設定は少なくなります。

[Azure Web ジョブの追加] ダイアログ ボックス

[Web ジョブAzure追加] ダイアログ ボックスでは、Web ジョブの名前と実行モードの設定を入力できます。

このダイアログ ボックスの一部のフィールドは、Azure ポータルの Add WebJob ダイアログ ボックスのフィールドに対応しています。 詳細については、「 Azure App Serviceを参照してください。

Web ジョブのデプロイ情報:

• コマンド ラインデプロイの詳細については、「Azure Web ジョブのコマンド ラインの有効化または継続的デリバリーを参照してください。

• Web ジョブをデプロイした後、Web ジョブの種類を変更して再デプロイする場合は、 webjobs-publish-settings.json ファイルを削除します。 これにより、Visual Studioが発行オプションを再表示するため、Web ジョブの種類を変更できます。

• Web ジョブをデプロイした後、continuous と triggered の間で実行モードを変更Visual Studio、再デプロイ時にAzureに新しい Web ジョブを作成します。 他のスケジュール設定を変更しても、実行モードを同じままにするか、スケジュール設定とオンデマンドジョブを切り替えた場合、Visual Studioは新しいジョブを作成するのではなく、既存のジョブを更新します。

Web ジョブの種類

Webジョブの種類は、トリガー型または継続型のいずれかです。

• トリガー (既定): トリガーされた Web ジョブは、バインド イベント、 スケジュール、または手動で (オンデマンドで) トリガーされたときに開始されます。 Web アプリが実行されている 1 つのインスタンスで実行されます。

• 継続的: Web ジョブが作成されるとすぐに 、継続的 な Web ジョブが開始されます。 既定では、すべての Web アプリのスケーリングされたインスタンスで実行されますが、 settings.job を使用して 1 つのインスタンスとして実行するように構成できます。

トリガーされた Web ジョブのスケジュール設定

コンソール アプリをAzureに発行すると、Visual Studioは既定で Web ジョブの種類を Triggered に設定し、新しい settings.job ファイルをプロジェクトに追加します。 トリガーされた Web ジョブの種類の場合、このファイルを使用して Web ジョブの実行スケジュールを設定できます。

settings.job ファイルを使用して、Web ジョブの実行スケジュールを設定します。 次の例では、午前 9 時から午後 5 時まで 1 時間ごとに実行されます。

{
    "schedule": "0 0 9-17 * * *"
}

このファイルは、Web ジョブのスクリプト ( wwwroot\app_data\jobs\triggered\{job name} や wwwroot\app_data\jobs\continuous\{job name}など) を含む WebJobs フォルダーのルートにあります。 Visual Studioから Web ジョブをデプロイする場合は、Visual Studioの settings.job ファイル のプロパティを Copy (新しい場合) としてマーク。

Azure ポータルから Web ジョブを作成場合は、settings.job ファイルが自動的に作成されます。

CRON 式

WebJobs では、Azure Functionsのタイマー トリガーと同じ CRON 式をスケジュールに使用します。 CRON のサポートの詳細については、Azure Functions の Timer トリガー を参照してください。

settings.job 参照

WebJobs では、 settings.job ファイルで次の設定がサポートされています。

継続的な実行

Azureで Always on を有効にした場合は、Visual Studioを使用して Web ジョブを継続的に実行するように変更できます。

1. プロジェクトがまだ発行されていない場合は、プロジェクトをAzureに発行します。

2. Solution Explorer でプロジェクトを右クリックし、Publish を選択します。

3. [ 設定] セクションで、[ すべての設定を表示] を選択します。

4. [プロファイル設定] ダイアログ ボックスで、[Web ジョブの種類] で [連続] を選択し、[保存] を選択します。

   

5. [ 発行 ] タブで [ 発行 ] を選択し、更新された設定で Web ジョブを再発行します。

次のステップ