Azure Functions バージョン 3.x からバージョン 4.x にアプリを移行する

これらの手順では、ローカルの C# プロジェクトを想定しています。アプリで代わりに C# スクリプト (.csx ファイル) を使用する場合は、先 に進む前にプロジェクト モデルに変換する 必要があります。

.csproj XML プロジェクト ファイルでは、次の変更が必要です。

1. PropertyGroup の値を設定します。 TargetFramework から net8.0。

2. PropertyGroup の値を設定します。 AzureFunctionsVersion から v4。

3. 次の OutputType 要素を PropertyGroup に追加します。

   <OutputType>Exe</OutputType>
   

4. ItemGroup では、 PackageReference リストで、Microsoft.NET.Sdk.Functions へのパッケージ参照を次の参照に置き換えます。

     <FrameworkReference Include="Microsoft.AspNetCore.App" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.21.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.17.2" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="1.2.1" />
     <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />
   

   Microsoft.Azure.WebJobs.* 名前空間内の他のパッケージへの参照を書き留めます。 これらのパッケージは後の手順で置き換えます。

5. 次の新しい ItemGroup を追加します。

   <ItemGroup>
     <Using Include="System.Threading.ExecutionContext" Alias="ExecutionContext"/>
   </ItemGroup>
   

これらの変更を行うと、更新されたプロジェクトは次の例のようになります。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
    <RootNamespace>My.Namespace</RootNamespace>
    <OutputType>Exe</OutputType>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>
  <ItemGroup>
    <FrameworkReference Include="Microsoft.AspNetCore.App" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.21.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.17.2" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="1.2.1" />
    <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />
    <!-- Other packages may also be in this list -->
  </ItemGroup>
  <ItemGroup>
    <None Update="host.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
  </ItemGroup>
  <ItemGroup>
    <Using Include="System.Threading.ExecutionContext" Alias="ExecutionContext"/>
  </ItemGroup>
</Project>

これらの手順では、ローカルの C# プロジェクトを想定しています。アプリで代わりに C# スクリプト (.csx ファイル) を使用する場合は、先 に進む前にプロジェクト モデルに変換する 必要があります。

.csproj XML プロジェクト ファイルでは、次の変更が必要です。

1. PropertyGroup の値を設定します。 TargetFramework から net48。

2. PropertyGroup の値を設定します。 AzureFunctionsVersion から v4。

3. 次の OutputType 要素を PropertyGroup に追加します。

   <OutputType>Exe</OutputType>
   

4. ItemGroup では、 PackageReference リストで、Microsoft.NET.Sdk.Functions へのパッケージ参照を次の参照に置き換えます。

     <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.21.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.16.4" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.1.0" />
     <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />
   

   Microsoft.Azure.WebJobs.* 名前空間内の他のパッケージへの参照を書き留めます。 これらのパッケージは後の手順で置き換えます。

5. 次の新しい ItemGroup を追加します。

   <ItemGroup>
     <Folder Include="Properties\" />
   </ItemGroup>
   

これらの変更を行うと、更新されたプロジェクトは次の例のようになります。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net48</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
    <RootNamespace>My.Namespace</RootNamespace>
    <OutputType>Exe</OutputType>
  </PropertyGroup>
  <ItemGroup>
      <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.21.0" />
      <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.16.4" />
      <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.1.0" />
      <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
      <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />
    <!-- Other packages may also be in this list -->
  </ItemGroup>
  <ItemGroup>
    <None Update="host.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
  </ItemGroup>
  <ItemGroup>
    <Folder Include="Properties\" />
  </ItemGroup>
</Project>

.csproj XML プロジェクト ファイルには、次の変更を加える必要があります。

1. PropertyGroup の値を設定します。 TargetFramework から net8.0。

2. PropertyGroup の値を設定します。 AzureFunctionsVersion から v4。

3. 既存の ItemGroup を置き換えます。 PackageReference リストを次の ItemGroup に置き換えます。

   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.4.0" />
   </ItemGroup>
   

これらの変更を行うと、更新されたプロジェクトは次の例のようになります。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
    <RootNamespace>My.Namespace</RootNamespace>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.4.0" />
  </ItemGroup>
  <ItemGroup>
    <None Update="host.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
  </ItemGroup>
</Project>

まだ更新していない場合、次に示すものの最新の安定バージョンを参照するようにプロジェクトを更新します。

• Microsoft.Azure。Functions.Worker
• Microsoft.Azure.Functions.Worker.Sdk

アプリが使用するトリガーとバインドによっては、アプリは別のパッケージ セットを参照する必要がある場合があります。 次の表に、最も一般的に使用されるいくつかの拡張機能の置換を示します。

検討するべき拡張機能の全一覧については、「サポートされているバインド」を参照し、分離プロセス モデルの完全なインストール手順については、各拡張機能のドキュメントを参照してください。 対象としているすべてのパッケージの最新の安定バージョンをインストールするようにしてください。

分離ワーカー モデル アプリケーションでは、Microsoft.Azure.WebJobs.* 名前空間または Microsoft.Azure.Functions.Extensions 内のパッケージを参照しないでください。 これらへの参照が何か残っている場合は、それらを削除する必要があります。

まだ更新していない場合、次に示すものの最新の安定バージョンを参照するようにプロジェクトを更新します。

• Microsoft.Azure。Functions.Worker
• Microsoft.Azure.Functions.Worker.Sdk

アプリが使用するトリガーとバインドによっては、アプリは別のパッケージ セットを参照する必要がある場合があります。 次の表に、最も一般的に使用されるいくつかの拡張機能の置換を示します。

検討するべき拡張機能の全一覧については、「サポートされているバインド」を参照し、分離プロセス モデルの完全なインストール手順については、各拡張機能のドキュメントを参照してください。 対象としているすべてのパッケージの最新の安定バージョンをインストールするようにしてください。

分離ワーカー モデル アプリケーションでは、Microsoft.Azure.WebJobs.* 名前空間または Microsoft.Azure.Functions.Extensions 内のパッケージを参照しないでください。 これらへの参照が何か残っている場合は、それらを削除する必要があります。

Microsoft.NET の最新の安定したバージョンを参照するようにプロジェクトを更新します。Sdk.Functions。

アプリが使用するトリガーとバインドによっては、アプリは追加のパッケージ セットを参照する必要がある場合があります。 検討するべき拡張機能の一覧については、「サポートされているバインド」を参照し、インプロセス プロセス モデルの完全なインストール手順については、各拡張機能のドキュメントを参照してください。 対象としているすべてのパッケージの最新の安定バージョンをインストールするようにしてください。

using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var host = new HostBuilder()
    .ConfigureFunctionsWebApplication()
    .ConfigureServices(services => {
        services.AddApplicationInsightsTelemetryWorkerService();
        services.ConfigureFunctionsApplicationInsights();
    })
    .Build();

host.Run();

この例にはASP.NET Core統合が含まれており、アプリで HTTP トリガーを使用する場合にパフォーマンスを向上させ、使い慣れたプログラミング モデルを提供します。 HTTP トリガーを使用しない場合は、 ConfigureFunctionsWebApplication の呼び出しを ConfigureFunctionsWorkerDefaultsの呼び出しに置き換えることができます。 その場合は、プロジェクト ファイルから Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore への参照を削除できます。 ただし、パフォーマンスを最大限に高めるには、他のトリガーの種類の関数であっても、FrameworkReferenceを ASP.NET Coreしておく必要があります。

Program.cs ファイルは、FunctionsStartup属性を持つファイル (通常はStartup.cs ファイル) を置き換えます。 FunctionsStartupコードがIFunctionsHostBuilder.Servicesを参照する場所では、代わりにProgram.csの.ConfigureServices()のHostBuilder メソッド内にステートメントを追加できます。 Program.csの操作の詳細については、分離ワーカー モデル ガイドのスタートアップと構成に関するページを参照してください。

前に説明した既定 のProgram.cs 例には、 Application Insights のセットアップが含まれます。 Program.csでは、プロジェクト内のコードからのログに適用する必要があるログ フィルター処理も構成する必要があります。 分離ワーカー モデルでは、 host.json ファイルは Functions ホスト ランタイムによって出力されるイベントのみを制御します。 Program.csでフィルター規則を構成しない場合は、テレメトリのさまざまなカテゴリに対してログ レベルの違いが表示されることがあります。

カスタム構成ソースは HostBuilderの一部として登録できますが、これらは同様にプロジェクト内のコードにのみ適用されます。 プラットフォームにはトリガーとバインドの構成も必要です。これは、アプリケーション設定、Key Vault参照、または App Configuration references 機能を通じて提供する必要があります。

既存の FunctionsStartup から Program.cs ファイルにすべてを移動した後、 FunctionsStartup 属性とその適用先のクラスを削除できます。

using Microsoft.Extensions.Hosting;
using Microsoft.Azure.Functions.Worker;

namespace Company.FunctionApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            FunctionsDebugger.Enable();

            var host = new HostBuilder()
                .ConfigureFunctionsWorkerDefaults()
                .ConfigureServices(services => {
                    services.AddApplicationInsightsTelemetryWorkerService();
                    services.ConfigureFunctionsApplicationInsights();
                })
                .Build();
            host.Run();
        }
    }
}

Program.cs ファイルは、FunctionsStartup属性を持つファイル (通常はStartup.cs ファイル) を置き換えます。 FunctionsStartupコードがIFunctionsHostBuilder.Servicesを参照する場所では、代わりにProgram.csの.ConfigureServices()のHostBuilder メソッド内にステートメントを追加できます。 Program.csの操作の詳細については、分離ワーカー モデル ガイドのスタートアップと構成に関するページを参照してください。

前に説明した既定 のProgram.cs 例には、 Application Insights のセットアップが含まれます。 Program.csでは、プロジェクト内のコードからのログに適用する必要があるログ フィルター処理も構成する必要があります。 分離ワーカー モデルでは、 host.json ファイルは Functions ホスト ランタイムによって出力されるイベントのみを制御します。 Program.csでフィルター規則を構成しない場合は、テレメトリのさまざまなカテゴリに対してログ レベルの違いが表示されることがあります。

カスタム構成ソースは HostBuilderの一部として登録できますが、これらは同様にプロジェクト内のコードにのみ適用されます。 プラットフォームにはトリガーとバインドの構成も必要です。これは、アプリケーション設定、Key Vault参照、または App Configuration references 機能を通じて提供する必要があります。

既存の FunctionsStartup から Program.cs ファイルにすべてを移動した後、 FunctionsStartup 属性とその適用先のクラスを削除できます。

インプロセス モデルを使用している場合、 Program.cs ファイルは必要ありません。

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "AzureWebJobsStorageConnectionStringValue",
        "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated"
    }
}

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "AzureWebJobsStorageConnectionStringValue",
        "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated"
    }
}

{
    "IsEncrypted": false,
    "Values": {
        "AzureWebJobsStorage": "AzureWebJobsStorageConnectionStringValue",
        "FUNCTIONS_WORKER_RUNTIME": "dotnet",
        "FUNCTIONS_INPROC_NET8_ENABLED": "1"
    }
}

host.json ファイルに変更は必要ありません。 ただし、インプロセス モデル プロジェクトからこのファイル内の Application Insights 構成を行う場合は、 Program.cs ファイルに他の変更を加える必要があります。 host.json ファイルが制御するのは、Functions ホスト ランタイムからのログだけであり、分離ワーカー モデルでは、これらのログの一部はアプリケーションから直接取得されるため、より詳細な制御が可能になります。 これらのログをフィルター処理する方法の詳細については、「分離ワーカー モデルでのログ レベルの管理」を参照してください。

host.json ファイルに変更は必要ありません。 ただし、インプロセス モデル プロジェクトからこのファイル内の Application Insights 構成を行う場合は、 Program.cs ファイルに他の変更を加える必要があります。 host.json ファイルが制御するのは、Functions ホスト ランタイムからのログだけであり、分離ワーカー モデルでは、これらのログの一部はアプリケーションから直接取得されるため、より詳細な制御が可能になります。 これらのログをフィルター処理する方法の詳細については、「分離ワーカー モデルでのログ レベルの管理」を参照してください。

host.json ファイルに変更は必要ありません。

このセクションでは、移行を行う際に考慮する必要があるその他のコード変更に焦点を当てます。 これらの変更はすべてのアプリケーションで必要なわけではありませんが、シナリオに関連するかどうかを評価する必要があります。 プロジェクトに加える必要があるその他の変更については、 必ず 3.x から 4.x の間の破壊的 変更を確認してください。

JSON シリアル化

既定では、分離されたワーカー モデルでは、JSON シリアル化に System.Text.Json が使用されます。 シリアライザー のオプションをカスタマイズしたり、JSON に切り替えたりするには.NET (Newtonsoft.Json) を参照してください JSON シリアル化のカスタマイズ。

Application Insights のログ レベルとフィルター処理

ログは、Functions ホスト ランタイムとプロジェクト内のコードの両方から Application Insights に送信できます。 host.json を使用すると、ホスト ログの規則を構成できますが、コードからのログを制御するには、Program.csの一部としてフィルター規則を構成する必要があります。 これらのログをフィルター処理する方法の詳細については、「分離ワーカー モデルでのログ レベルの管理」を参照してください。

このセクションでは、移行を行う際に考慮する必要があるその他のコード変更に焦点を当てます。 これらの変更はすべてのアプリケーションで必要なわけではありませんが、シナリオに関連するかどうかを評価する必要があります。 プロジェクトに加える必要があるその他の変更については、 必ず 3.x から 4.x の間の破壊的 変更を確認してください。

JSON シリアル化

既定では、分離されたワーカー モデルでは、JSON シリアル化に System.Text.Json が使用されます。 シリアライザー のオプションをカスタマイズしたり、JSON に切り替えたりするには.NET (Newtonsoft.Json) を参照してください JSON シリアル化のカスタマイズ。

Application Insights のログ レベルとフィルター処理

ログは、Functions ホスト ランタイムとプロジェクト内のコードの両方から Application Insights に送信できます。 host.json を使用すると、ホスト ログの規則を構成できますが、コードからのログを制御するには、Program.csの一部としてフィルター規則を構成する必要があります。 これらのログをフィルター処理する方法の詳細については、「分離ワーカー モデルでのログ レベルの管理」を参照してください。

プロジェクトに加える必要があるその他の変更については、 必ず 3.x から 4.x の間の破壊的 変更を確認してください。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

namespace Company.Function
{
    public class HttpTriggerCSharp
    {
        private readonly ILogger<HttpTriggerCSharp> _logger;

        public HttpTriggerCSharp(ILogger<HttpTriggerCSharp> logger)
        {
            _logger = logger;
        }

        [Function("HttpTriggerCSharp")]
        public IActionResult Run(
            [HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequest req)
        {
            _logger.LogInformation("C# HTTP trigger function processed a request.");

            return new OkObjectResult($"Welcome to Azure Functions, {req.Query["name"]}!");
        }
    }
}

using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.Extensions.Logging;
using System.Net;

namespace Company.Function
{
    public class HttpTriggerCSharp
    {
        private readonly ILogger<HttpTriggerCSharp> _logger;

        public HttpTriggerCSharp(ILogger<HttpTriggerCSharp> logger)
        {
            _logger = logger;
        }

        [Function("HttpTriggerCSharp")]
        public HttpResponseData Run([HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequestData req)
        {
            _logger.LogInformation("C# HTTP trigger function processed a request.");

            var response = req.CreateResponse(HttpStatusCode.OK);
            response.Headers.Add("Content-Type", "text/plain; charset=utf-8");

            response.WriteString($"Welcome to Azure Functions, {req.Query["name"]}!");

            return response;
        }
    }
}

バージョン 3.x (インプロセス) と同じです。