Visual Studio を使用する Azure Functions の開発

[アーティクル]
03/27/2023

Visual Studio で、C# クラスライブラリ関数を開発して、テストし、Azure にデプロイすることができます。 Azure Functions を初めて使用する場合は、「Azure Functions の概要」を参照してください。

Visual Studio には、関数の開発時の利点として次のようなものがあります。

ローカル開発用コンピューターで関数を編集、作成、および実行できます。
Azure Functions プロジェクトを Azure に直接発行し、必要に応じて Azure リソースを作成します。
C# 属性を使用して、C# コードで直接、関数のバインドを宣言できます。
コンパイル済み C# 関数を開発およびデプロイできます。コンパイル済み関数では、C# スクリプトベースの関数より優れたコールドスタートパフォーマンスが得られます。
Visual Studio 開発のすべての利点を得ながら、C# で関数をコーディングできます。

この記事では、Visual Studio を使って C# クラスライブラリ関数を開発して Azure に発行する方法に関する詳細情報を提供します。この記事を読む前に、Visual Studio 用の関数のクイックスタートに関するページを完了することをお勧めします。

特に明記されていない限り、ここで示す手順と例は Visual Studio 2022 のものです。 Visual Studio 2022 リリースの詳細については、リリースノートまたはプレビューリリースノートを参照してください。

前提条件

Azure Functions Tools。 Azure Function Tools を追加するには、Visual Studio のインストールに Azure 開発ワークロードを含めます。 Visual Studio 2017 を使用している場合は、追加のインストール手順に従う必要があります。
Azure Storage アカウントなど、他の必要なリソースは、発行プロセス中にサブスクリプションに作成されます。
Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。

Azure Functions プロジェクトを作成する

Visual Studio の Azure Functions プロジェクトテンプレートを使用すると、Azure の関数アプリに発行できる C# クラスライブラリプロジェクトを作成できます。関数アプリを使用すると、リソースの管理、デプロイ、スケーリング、および共有を容易にするための論理ユニットとして関数をグループ化できます。

Visual Studio メニューで、 [ファイル]>[新規]>[プロジェクト] を選択します。
[新しいプロジェクトの作成] の検索ボックスに「functions」と入力し、Azure Functions テンプレートを選択してから、 [次へ] を選択します。
[新しいプロジェクトの構成] で、プロジェクトのプロジェクト名を入力し、 [作成] を選択します。関数アプリ名は、C# 名前空間として有効である必要があります。そのため、アンダースコア、ハイフン、その他の英数字以外の文字は使用しないでください。

[新しい Azure Functions アプリケーションの作成] 設定で、次の表の値を使用します。

インプロセス
分離プロセス

設定	値	説明
.NET のバージョン	.NET 6	この値により、Azure Functions ランタイムのバージョン 4.x でインプロセスを実行する関数プロジェクトが作成されます。 Azure Functions 1.x では、.NET Framework がサポートされます。詳細については、「Azure Functions ランタイムバージョンをターゲットにする方法」をご覧ください。
関数テンプレート	HTTP トリガー	この値は、HTTP 要求によってトリガーされる関数を作成します。
ストレージアカウント (AzureWebJobsStorage)	ストレージエミュレーター	Azure の関数アプリにはストレージアカウントが必要であるため、プロジェクトを Azure に発行する際に割り当てられるか、作成されます。 HTTP トリガーによって、Azure Storage アカウントの接続文字列が使用されることはありません。その他のすべてのトリガーの種類には、有効な Azure Storage アカウントの接続文字列が必要です。
承認レベル	匿名	作成される関数を、すべてのクライアントがキーを使用せずにトリガーできます。この承認設定により、新しい関数のテストが容易になります。キーと承認の詳細については、「承認キー」と HTTP と Webhook のバインドに関するページをご覧ください。

Azure Functions プロジェクトの設定

設定	値	説明
.NET のバージョン	.NET 6 Isolated	この値により、分離ワーカープロセスで実行される関数プロジェクトが作成されます。詳細については、「Azure Functions ランタイムバージョンをターゲットにする方法」をご覧ください。
関数テンプレート	HTTP トリガー	この値は、HTTP 要求によってトリガーされる関数を作成します。
ストレージアカウント (AzureWebJobsStorage)	ストレージエミュレーター	Azure の関数アプリにはストレージアカウントが必要であるため、プロジェクトを Azure に発行する際に割り当てられるか、作成されます。 HTTP トリガーによって、Azure Storage アカウントの接続文字列が使用されることはありません。その他のすべてのトリガーの種類には、有効な Azure Storage アカウントの接続文字列が必要です。
承認レベル	匿名	作成される関数を、すべてのクライアントがキーを使用せずにトリガーできます。この承認設定により、新しい関数のテストが容易になります。キーと承認の詳細については、「承認キー」と HTTP と Webhook のバインドに関するページをご覧ください。

Azure Functions プロジェクトの設定

[承認レベル] を [匿名] に設定していることを確認します。関数の既定のレベルを選択した場合、関数エンドポイントにアクセスする要求で、関数キーを提示する必要があります。

[作成] を選択して、関数プロジェクトと HTTP トリガー関数を作成します。

Azure Functions プロジェクトを作成した後、プロジェクトテンプレートを使用して C# プロジェクトを作成し、Microsoft.NET.Sdk.Functions NuGet パッケージをインストールし、ターゲットフレームワークを設定します。新しいプロジェクトには次のファイルが含まれます。

host.json:Functions のホストを構成できます。これらの設定は、ローカルでの実行時と Azure での実行時の両方に適用されます。詳細については、host.json のリファレンスを参照してください。
local.settings.json:関数をローカルで実行するときに使用される設定を保持します。 Azure で実行している場合、これらの設定は使用されません。詳細については、「ローカル設定ファイル」を参照してください。

重要

local.settings.json ファイルにはシークレットを含めることができるため、それをプロジェクトソース管理から除外する必要があります。このファイルの [出力ディレクトリにコピー] 設定が [新しい場合はコピーする] に設定されていることを確認します。

詳細については、「関数クラスライブラリプロジェクト」を参照してください。

ローカルでアプリの設定を操作する

Azure の関数アプリで実行する場合、関数に必要な設定はアプリ設定に安全に保存されます。ローカル開発中は、これらの設定は代わりに local.settings.json ファイルの Values コレクションに追加されます。 local.settings.json ファイルには、ローカルの開発ツールによって使用される設定も格納されます。

プロジェクトの local.settings.json ファイルの Values コレクションにある項目は、Azure の関数アプリのアプリケーション設定にある項目をミラー化するためのものです。

プロジェクトを発行しても、Visual Studio では local.settings.json の設定が自動的にアップロードされません。これらの設定が Azure の Function App にも確実に存在するようにするには、プロジェクトを発行した後にそれらをアップロードします。詳細については、「Function App の設定」を参照してください。 ConnectionStrings コレクション内の値は発行されません。

コードを使用して、Function App の設定値を環境変数として読み取ることもできます。詳細については、「環境変数」を参照してください。

ローカル開発用のプロジェクトを構成する

Functions ランタイムでは内部的に Azure Storage アカウントを使用します。 HTTP と Webhook 以外のすべてのトリガーの種類について、Values.AzureWebJobsStorage キーを有効な Azure Storage アカウントの接続文字列に設定します。関数アプリでは、プロジェクトに必要な AzureWebJobsStorage 接続設定に Azure エミュレーターを使用することもできます。エミュレーターを使用するには、AzureWebJobsStorage の値を UseDevelopmentStorage=true に設定します。この設定は、デプロイ前に実際のストレージアカウント接続文字列に変更します。詳細については、ローカルストレージエミュレーターに関するページを参照してください。

ストレージアカウントの接続文字列を設定するには、次のようにします。

Azure Portal のストレージアカウントに移動します。
[アクセスキー] タブの [セキュリティ + ネットワーク] の下にある key1 の 接続文字列をコピーします。
プロジェクトで、local.settings.json ファイルを開き、コピーした接続文字列に AzureWebJobsStorage キーの値を設定します。
前の手順を繰り返し、関数に必要なその他のすべての接続について、Values 配列に一意のキーを追加します。

プロジェクトに関数を追加する

C# クラスライブラリ関数では、関数で使用されるバインドはコードで属性を適用することで定義されます。提供されているテンプレートから関数トリガーを作成する場合は、トリガー属性が適用されます。

ソリューションエクスプローラーで、プロジェクトノードを右クリックし、 [追加]>[新しいアイテム] の順に選択します。
[Azure 関数] を選択し、クラスの [名前] を入力して [追加] を選択します。
トリガーを選択し、バインドのプロパティを設定して、[追加] を選択します。次の例は、Queue storage トリガー関数を作成する場合の設定を示しています。

その後、Azurite ストレージエミュレーターか、プロビジョニングされた Azure ストレージアカウントを参照するかを選択するように求められます。

このトリガーの例では、QueueStorage という名前のキーと共に接続文字列を使用します。 local.settings.json ファイルに保存されているこのキーでは、Azurite エミュレーターまたは Azure ストレージアカウントを参照します。

新しく追加されたクラスを確認します。 FunctionName 属性で属性が指定された静的 Run() メソッドを確認します。この属性は、メソッドが関数のエントリポイントであることを示します。

たとえば、次の C# クラスは基本的な Queue storage トリガー関数を表します。

using System;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace FunctionApp1
{
    public static class Function1
    {
        [FunctionName("QueueTriggerCSharp")]
        public static void Run([QueueTrigger("myqueue-items", 
            Connection = "QueueStorage")]string myQueueItem, ILogger log)
        {
            log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
        }
    }
}

バインド固有の属性は、エントリポイントメソッドに指定された各バインドパラメーターに適用されます。属性ではパラメーターとしてバインド情報を取ります。前の例では、Queue storage トリガー関数を示す QueueTrigger 属性が最初のパラメーターに適用されています。キュー名および接続文字列の設定名は、パラメーターとして QueueTrigger 属性に渡されます。詳細については、Azure Functions での Azure Queue ストレージのバインドに関する記事を参照してください。

上記の手順を使用して、複数の関数を Function App プロジェクトに追加します。プロジェクト内の各関数で異なるトリガーを使用できますが、1 つの関数には 1 つのトリガーのみを使用する必要があります。詳しくは、「Azure Functions でのトリガーとバインドの概念」をご覧ください。

バインドを追加する

トリガーと同じように、入力バインドと出力バインドも、バインド属性として関数に追加されます。以下のように、関数にバインドを追加します。

プロジェクトをローカル開発用に構成したことを確認します。
バインドの参照記事でバインド固有のNuGet パッケージ要件を見つけることで、特定のバインドに適したNuGet拡張パッケージを追加します。たとえば、Event Hubs トリガーのパッケージ要件については、Event Hubs のバインドの参照記事を参照してください。
パッケージマネージャーコンソールで次のコマンドを使用して、特定のパッケージをインストールします。
- インプロセス
- 分離プロセス
```
Install-Package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
```
```
Install-Package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
```
この例では、<BINDING_TYPE> をバインド拡張機能に固有の名前に置き換え、<TARGET_VERSION> を 3.0.0-beta5 などの特定のバージョンのパッケージに置き換えます。有効なバージョンは、NuGet.org の個々のパッケージページに記載されています。Functions ランタイム 1.x または 2.x に対応する主要なバージョンは、バインデイングのリファレンス記事に示されています。
バインドが必要なアプリ設定がある場合は、ローカル設定ファイルの Values コレクションに追加します。

この関数では、ローカルで実行するときにこれらの値を使用します。関数が Azure の Function App で実行される場合は、Function App の設定が使用されます。

適切なバインド属性をメソッドシグネチャに追加します。次の例では、キューメッセージによって関数がトリガーされ、出力バインドによって、同じテキストの新しいキューメッセージが別のキューに作成されます。

public static class SimpleExampleWithOutput
{
    [FunctionName("CopyQueueMessage")]
    public static void Run(
        [QueueTrigger("myqueue-items-source", Connection = "AzureWebJobsStorage")] string myQueueItem, 
        [Queue("myqueue-items-destination", Connection = "AzureWebJobsStorage")] out string myQueueItemCopy,
        ILogger log)
    {
        log.LogInformation($"CopyQueueMessage function processed: {myQueueItem}");
        myQueueItemCopy = myQueueItem;
    }
}

Queue Storage への接続は、AzureWebJobsStorage 設定から取得されます。詳しくは、特定のバインドの参照記事をご覧ください。

Functions でサポートされるバインドを網羅した一覧については、「サポートされるバインディング」を参照してください。

関数をローカルで実行する

Azure Functions Core Tools を使用すると、ローカルの開発用コンピューター上で Azure Functions プロジェクトを実行できます。 Functions プロジェクトをデバッグするために F5 キーを押すと、ローカル Functions ホスト (func.exe) が起動し、ローカルポート (通常は 7071) をリッスンします。呼び出し可能な関数エンドポイントが出力に書き込まれるので、それらのエンドポイントを関数のテストに使用できます。詳細については、「Azure Functions Core Tools の操作」を参照してください。 Visual Studio から初めて関数を起動すると、これらのツールをインストールするよう求めるメッセージが表示されます。

Visual Studio のデバッグモードで関数を開始するには、次のようにします。

F5 キーを押す。メッセージが表示されたら、Visual Studio からの要求に同意し、Azure Functions Core (CLI) ツールをダウンロードしてインストールします。また、ツールで HTTP 要求を処理できるように、ファイアウォールの例外を有効にすることが必要になる場合もあります。
プロジェクトを実行して、デプロイ済みの関数をテストする場合と同じようにコードをテストします。

Visual Studio をデバッグモードで実行すると、想定どおりにブレークポイントにヒットします。

Visual Studio を使用したテストに関する詳細なシナリオについては、「関数のテスト」を参照してください。

Azure に発行する

Visual Studio から発行する場合は、次の 2 つのデプロイ方法のいずれかが使用されます。

Web 配置:Windows アプリをパッケージ化して任意の IIS サーバーに配置します。
Run-From-Package を有効にした Zip デプロイ: Azure Functions のデプロイに推奨されます。

次の手順を使用して、プロジェクトを Azure の Function App に発行します。

ソリューションエクスプローラーで、プロジェクトを右クリックし、 [発行] を選択します。 [ターゲット]で、[Azure] を選択し、[次へ] を選択します。
[特定のターゲット] で [Azure Function App (Windows)] を選択して、Windows で実行される関数アプリを作成し、[次へ] を選択します。
[関数インスタンス] で、[新しい Azure 関数を作成] を選択します。

次の表に示されている値を使用して、新しいインスタンスを作成します。

設定	値	説明
名前	グローバルに一意の名前	新しい関数アプリを一意に識別する名前。この名前をそのまま使用するか、新しい名前を入力します。有効な文字は、`a-z`、`0-9`、`-` です。
サブスクリプション	該当するサブスクリプション	使用する Azure サブスクリプション。このサブスクリプションを承諾するか、ドロップダウンリストから新しいものを選択します。
リソースグループ	リソースグループの名前	関数アプリを作成するリソースグループ。ドロップダウンリストから既存のリソースグループを選択するか、または [新規] を選択して新しいリソースグループを作成します。
プランの種類	従量課金	従量課金プランで実行される関数アプリにプロジェクトを発行する場合は、関数アプリの実行に対してのみお支払いください。他のホスティングプランでは、コストが高くなります。
場所	App Service の場所	最寄りのリージョンまたは関数がアクセスする他のサービスの近くのリージョン内の [場所] を選択します。
Azure Storage	汎用ストレージアカウント	Functions の共通言語ランタイムでは、Azure ストレージアカウントが必要です。 [新規] を選択して汎用ストレージアカウントを構成します。または、ストレージアカウントの要件を満たす既存のアカウントを選択することもできます。

App Service 作成ダイアログのスクリーンショット。

[作成] を選択して、関数アプリとその関連リソースを Azure で作成します。リソース作成のステータスがウィンドウの左下に表示されます。
[関数インスタンス] で、[パッケージファイルから実行します] に必ずチェックを入れてください。関数アプリは、Zip Deploy を使用して、Run-From-Package モードが有効な状態でデプロイされます。 Zip Deploy は、関数プロジェクトの推奨されるデプロイ方法であり、パフォーマンスが向上します。
[完了] を選択し、[発行] ページで [発行] を選択して、プロジェクトファイルを含むパッケージを Azure の新しい関数アプリにデプロイします。

デプロイが完了すると、Azure の関数アプリのルート URL が [発行] タブに表示されます。
[発行] タブの [ホスティング] セクションで、[Azure portal で開く] を選択します。これにより、Azure portal に新しい関数アプリの Azure リソースが開きます。

Function App の設定

Visual Studio では、プロジェクトを発行するときにこれらの設定が自動的にアップロードされることはありません。 local.settings.json に追加したすべての設定は、Azure の関数アプリにも追加する必要があります。

Azure の関数アプリに必要な設定をアップロードする最も簡単な方法は、[ホスティング] セクションの横にある 3 つの点を展開し、プロジェクトが正常に発行された後に表示される [Azure App Service の設定を管理する] リンクを選択することです。

[発行] ウィンドウの設定

このリンクを選択すると、Function App の [アプリケーションの設定] ダイアログが表示され、ここで新しいアプリケーション設定を追加したり、既存の設定を変更したりできます。

アプリケーションの設定

[ローカル] には local.settings.json ファイルの設定値が表示され、 [リモート] には Azure の Function App の現在の設定値が表示されます。新しいアプリ設定を作成するには、 [設定の追加] を選択します。 [ローカルから値を挿入する] リンクを使用して、設定値を [リモート] フィールドにコピーします。 [OK] を選択すると、保留中の変更がローカル設定ファイルと Function App に書き込まれます。

Note

既定では、local.settings.json ファイルはソース管理にチェックインされません。これは、ソース管理からローカル関数プロジェクトを複製するときに、プロジェクトに local.settings.json ファイルがないことを意味します。この場合、 [アプリケーション設定] ダイアログが期待どおりに動作するように、プロジェクトのルートに local.settings.json ファイルを手動で作成する必要があります。

以下のいずれかの方法を使用して、アプリケーション設定を管理することもできます。

Remote Debugging

関数アプリをリモートでデバッグするには、プロジェクトのデバッグ構成を発行する必要があります。また、Azure の関数アプリでリモートデバッグを有効にする必要もあります。

このセクションでは、リリース構成を使用して関数アプリに既に発行していることを前提としています。

リモートデバッグに関する考慮事項

運用環境のサービスでは、リモートデバッグはお勧めしません。
マイコードのみのデバッグを有効にしている場合は、無効にします。
リモートデバッグ時、ブレークポイントで長時間停止させることは避けてください。数分以上停止しているプロセスは、応答していないプロセスと見なされ、Azure によりシャットダウンされます。
デバッグ中は、サーバーから Visual Studio にデータが送信されるため、帯域幅の使用料に影響が及ぶ可能性があります。帯域幅使用料については、 Azure 料金計算ツールを参照してください。
リモートデバッグは、関数アプリで 48 時間後に自動的に無効になります。 48 時間後に、リモートデバッグを再度有効化する必要があります。

デバッガーをアタッチします。

デバッガーをアタッチする方法は、実行モードによって異なります。分離ワーカープロセスアプリをデバッグする場合、現在はリモートデバッガーを別の .NET プロセスにアタッチする必要があり、その他にもいくつかの構成手順が必要です。

完了したら、リモートデバッグを無効にする必要があります。

インプロセス
分離プロセス

Functions ホストを使用してインプロセスで実行されている関数アプリにリモートデバッガーをアタッチするには、次のようにします。

[発行] タブの [ホスティング] セクションで省略記号 (...) を選択し、[デバッガーのアタッチ] を選択します。

Visual Studio は関数アプリに接続し、まだ有効になっていない場合はリモートデバッグを有効にします。また、アプリのホストプロセスにデバッガーを見つけてアタッチします。この時点で、関数アプリを通常どおりにデバッグできます。

Functions ホストとは別のプロセスで動作している Function アプリにリモートデバッガーをアタッチするには、次のようにします。

[発行] タブの [ホスティング] セクションで省略記号 (...) を選択し、[発行プロファイルのダウンロード] を選択します。この操作により、発行プロファイルのコピーがダウンロードされ、ダウンロード場所が開きます。このファイルは必須で、Azure で実行されている分離ワーカープロセスにアタッチするために使用される資格情報が含まれています。

注意事項

.publishettings ファイルには、関数アプリを管理するために使用される認証情報 (エンコードされていない) が含まれています。このファイルのセキュリティ上のベストプラクティスは、ソースディレクトリの外 (例えばLibrariesDocuments フォルダー) に一時的に保存し、不要になった後に削除することです。悪意のあるユーザーが .publishsettings ファイルへのアクセス許可を取得すると、関数アプリを編集、作成、削除できるためです。
再度、[発行] タブの [ホスティング] セクションで省略記号 (...) を選択し、[デバッガーのアタッチ] を選択します。

Visual Studio は関数アプリに接続し、まだ有効になっていない場合はリモートデバッグを有効にします。

注意

リモートデバッガーはホストプロセスに接続できないため、エラーが表示される可能性があります。いずれの場合も、既定のデバッグはコードを中断しません。
Visual Studio に戻り、[発行] ページの [ホスティング] の下にある [サイト] の URL をコピーします。
[デバッグ] メニューから [プロセスにアタッチ] を選択し、[プロセスにアタッチ] ウィンドウで、URL を [接続先] に貼り付け、https:// を削除してポート :4024 に追加します。

ターゲットが <FUNCTION_APP>.azurewebsites.net:4024 と表示されることを確認し、[Enter] キーを押します。
メッセージが表示されたら、ローカルファイアウォール経由で Visual Studio へのアクセスを許可します。
資格情報の入力を求められた場合、ローカルユーザーの資格情報ではなく、別のアカウントを選択します (Windows ではその他の選択肢)。 Windows の認証ダイアログで、[メールアドレス]と[パスワード]に発行プロファイルのuserNameとuserPWDの値を指定します。デプロイサーバーとのセキュリティで保護された接続が確立されると、使用可能なプロセスが表示されます。
[すべてのユーザーからのプロセスを表示する] を選択し、[dotnet.exe] を選択して [アタッチ] を選択します。操作が完了すると、分離ワーカープロセスで実行されている C# クラスライブラリコードにアタッチされます。この時点で、関数アプリを通常どおりにデバッグできます。

リモートデバッグの無効化

コードのリモートデバッグが完了したら、Azure portal でリモートデバッグを無効にする必要があります。リモートデバッグは、忘れた場合でも 48 時間後に自動的に無効になります。

プロジェクトの [発行] タブで、[ホスティング] セクションで省略記号 (...) を選択し、[Azure Portal で開く] を選択します。このアクションにより、プロジェクトのデプロイ先の Azure portal で関数アプリが開きます。
関数アプリの、[設定] で [構成] を選択し、[全般設定] を選択し、[リモートデバッグ] をオフに設定して、[保存] を選択して [続行] を選択します。

関数アプリの再起動後、リモートプロセスにリモート接続できなくなります。同じタブを Azure portal で使用して、Visual Studio の外部でリモートデバッグを有効できます。

関数の監視

関数の実行を監視するための推奨される方法は、Function App を Azure Application Insights と統合することです。 Azure Portal で Function App を作成する場合、この統合は、既定で自動的に行われます。ただし、Visual Studio の発行中に Function App を作成する場合は、Azure で Function App の統合は実行されません。 Application Insights を関数アプリに接続する方法については、「Application Insights との統合を有効にする」を参照してください。

Application Insights を使用した監視の詳細については、「Azure Functions を監視する」を参照してください。

関数のテスト

このセクションでは、C# の関数アプリプロジェクトを Visual Studio で作成し、xUnit を使った実行とテストを行う方法について説明します。

Visual Studio で C# を使って Azure Functions をテストする

セットアップ

環境を設定するには、関数を作成し、アプリをテストします。次の手順では、テストをサポートするために必要なアプリと関数を作成できます。

新しい関数アプリを作成して Functions という名前を付けます
テンプレートから HTTP 関数を作成して MyHttpTrigger という名前を付けます。
テンプレートからタイマー関数を作成して MyTimerTrigger という名前を付けます。
ソリューションで xUnit テストアプリを作成して Functions.Tests という名前を付けます。既定のテストファイルを削除します。
NuGet を使用して、テストアプリから Microsoft.AspNetCore.Mvc への参照を追加します
Functions.Tests アプリから Functions アプリを参照します。

テストクラスの作成

これでプロジェクトが作成されたため、自動テストの実行に使用するクラスを作成できます。

各関数は、ILogger のインスタンスを取得して、メッセージログを処理します。テストによっては、メッセージをログに記録しないことも、ログの実装方法に対する懸念がないこともあります。その他のテストは、テストを渡すかどうかを判断するために、ログに記録されたメッセージを評価する必要があります。

テストの間に評価するメッセージの内部リストを保持する ListLogger という名前の新しいクラスを作成します。必要な ILogger インターフェイスを実装するには、クラスにスコープが必要です。次のクラスでは、ListLogger クラスに渡すテストケースのスコープがモックされます。

Functions.Tests プロジェクトに NullScope.cs という名前の新しいクラスを作成し、次のコードを入力します。

using System;

namespace Functions.Tests
{
    public class NullScope : IDisposable
    {
        public static NullScope Instance { get; } = new NullScope();

        private NullScope() { }

        public void Dispose() { }
    }
}

次に、Functions.Tests プロジェクトに ListLogger.cs という名前の新しいクラスを作成し、次のコードを入力します。

using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Text;

namespace Functions.Tests
{
    public class ListLogger : ILogger
    {
        public IList<string> Logs;

        public IDisposable BeginScope<TState>(TState state) => NullScope.Instance;

        public bool IsEnabled(LogLevel logLevel) => false;

        public ListLogger()
        {
            this.Logs = new List<string>();
        }

        public void Log<TState>(LogLevel logLevel,
                                EventId eventId,
                                TState state,
                                Exception exception,
                                Func<TState, Exception, string> formatter)
        {
            string message = formatter(state, exception);
            this.Logs.Add(message);
        }
    }
}

ListLogger クラスは、ILogger インターフェイスによって縮小される次のメンバーを実装します。

BeginScope:スコープがログにコンテキストを追加します。この場合、テストで NullScope クラスの静的インスタンスをポイントするだけで、テストを機能させることができます。
IsEnabled:既定の値 false が指定されます。
Log:このメソッドは、指定された formatter 関数を使用してメッセージの書式を設定してから、結果のテキストを Logs コレクションに追加します。

Logs コレクションは List<string> のインスタンスであり、コンストラクターで初期化されます。

次に、Functions.Tests プロジェクトに LoggerTypes.cs という名前の新しいファイルを作成し、次のコードを入力します。

namespace Functions.Tests
{
    public enum LoggerTypes
    {
        Null,
        List
    }
}

この列挙型は、テストで使用されるロガーの種類を指定します。

次に、Functions.Tests プロジェクトに TestFactory.cs という名前の新しいクラスを作成し、次のコードを入力します。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Http.Internal;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Primitives;
using System.Collections.Generic;

namespace Functions.Tests
{
    public class TestFactory
    {
        public static IEnumerable<object[]> Data()
        {
            return new List<object[]>
            {
                new object[] { "name", "Bill" },
                new object[] { "name", "Paul" },
                new object[] { "name", "Steve" }

            };
        }

        private static Dictionary<string, StringValues> CreateDictionary(string key, string value)
        {
            var qs = new Dictionary<string, StringValues>
            {
                { key, value }
            };
            return qs;
        }

        public static HttpRequest CreateHttpRequest(string queryStringKey, string queryStringValue)
        {
            var context = new DefaultHttpContext();
            var request = context.Request;
            request.Query = new QueryCollection(CreateDictionary(queryStringKey, queryStringValue));
            return request;
        }

        public static ILogger CreateLogger(LoggerTypes type = LoggerTypes.Null)
        {
            ILogger logger;

            if (type == LoggerTypes.List)
            {
                logger = new ListLogger();
            }
            else
            {
                logger = NullLoggerFactory.Instance.CreateLogger("Null Logger");
            }

            return logger;
        }
    }
}

TestFactory クラスは、次のメンバーを実装します。

Data:このプロパティは、サンプルデータの IEnumerable コレクションを返します。キー値のペアは、クエリ文字列に渡される値を表します。
CreateDictionary:このメソッドは、キー/値ペアを引数として受け取り、クエリ文字列値を表す QueryCollection を作成するために使用する新しい Dictionary を返します。
CreateHttpRequest:このメソッドは、指定されたクエリ文字列パラメーターで初期化される HTTP 要求を作成します。
CreateLogger:このメソッドは、ロガーの種類に応じて、テストに使用されるロガークラスを返します。 ListLogger は、テストで評価に使用できるログ記録されたメッセージを追跡します。

最後に、Functions.Tests プロジェクトに FunctionsTests.cs という名前の新しいクラスを作成し、次のコードを入力します。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Xunit;

namespace Functions.Tests
{
    public class FunctionsTests
    {
        private readonly ILogger logger = TestFactory.CreateLogger();

        [Fact]
        public async void Http_trigger_should_return_known_string()
        {
            var request = TestFactory.CreateHttpRequest("name", "Bill");
            var response = (OkObjectResult)await MyHttpTrigger.Run(request, logger);
            Assert.Equal("Hello, Bill. This HTTP triggered function executed successfully.", response.Value);
        }

        [Theory]
        [MemberData(nameof(TestFactory.Data), MemberType = typeof(TestFactory))]
        public async void Http_trigger_should_return_known_string_from_member_data(string queryStringKey, string queryStringValue)
        {
            var request = TestFactory.CreateHttpRequest(queryStringKey, queryStringValue);
            var response = (OkObjectResult)await MyHttpTrigger.Run(request, logger);
            Assert.Equal($"Hello, {queryStringValue}. This HTTP triggered function executed successfully.", response.Value);
        }

        [Fact]
        public void Timer_should_log_message()
        {
            var logger = (ListLogger)TestFactory.CreateLogger(LoggerTypes.List);
            new MyTimerTrigger().Run(null, logger);
            var msg = logger.Logs[0];
            Assert.Contains("C# Timer trigger function executed at", msg);
        }
    }
}

このクラスで実装されるメンバーは次のとおりです。

Http_trigger_should_return_known_string:このテストは、HTTP 関数へのクエリ文字列値 name=Bill を含む要求を作成し、予期された応答が返されることを確認します。
Http_trigger_should_return_string_from_member_data:このテストは、xUnit 属性を使用して、HTTP 関数にサンプルデータを提供します。
Timer_should_log_message: このテストは、ListLogger のインスタンスを作成してタイマー関数に渡します。関数が実行されると、予期されたメッセージが存在することを確認するためにログがチェックされます。

テストでアプリケーションの設定にアクセスする場合は、モックされた環境変数の値を持つ IConfiguration インスタンスを関数に挿入できます。

テストの実行

テストを実行するには、テストエクスプローラーに移動し、[すべてのテストをビューで実行] を選択します。

Visual Studio で C# を使って Azure Functions をテストする

テストのデバッグ

テストをデバッグするには、テストにブレークポイントを設定し、テストエクスプローラーに移動して、[実行]> [前回の実行をデバッグする] の順に選択します。

Azure Functions tools with Visual Studio 2017

Azure Functions Tools は、Visual Studio 2017 以降の Azure 開発ワークロードで使用できます。 Visual Studio 2017 では、Azure 開発ワークロードによって Azure Functions Tools が別個の拡張機能としてインストールされます。 Visual Studio 2019 以降では、Azure Functions ツールの拡張機能が Visual Studio の一部として更新されます。

Visual Studio 2017 のインストールを更新する場合、Azure Functions Tools の最新バージョンを使用していることを確認してください。以下のセクションでは、Visual Studio 2017 の Azure Functions Tools 拡張機能を確認し、必要に応じて更新する方法について説明します。

Visual Studio 2017 でツールのバージョンを確認する

[ツール] メニューの [拡張機能と更新プログラム] を選択します。 [インストール済み]>[ツール] メニューを展開し、 [Azure Functions と Web ジョブツール] を選択します。
インストールされている [バージョン] をメモし、このバージョンをリリースノートに記載されている最新バージョンと比較します。
インストールされているバージョンが古い場合は、次のセクションの説明に従って Visual Studio でツールを更新します。

Visual Studio のツールを更新する

[拡張機能と更新プログラム] ダイアログで、 [更新プログラム]>[Visual Studio Marketplace] を展開し、 [Azure Functions と Web ジョブツール] 、 [更新] の順に選択します。
ツールの更新プログラムがダウンロードされたら、 [閉じる] を選択し、Visual Studio を閉じて、VSIX インストーラーを使用してツールの更新をトリガーします。
VSIX インストーラーで、 [変更] を選択してツールを更新します。
更新が完了したら、 [閉じる] を選択して Visual Studio を再起動します。

次のステップ

Azure Functions Core Tools の詳細については、「Azure Functions Core Tools の操作」を参照してください。

.NET クラスライブラリとしての関数の開発の詳細については、「Azure Functions C# 開発者向けリファレンス」を参照してください。この記事は、Azure Functions でサポートされる各種バインドを宣言するための属性の使用例にもリンクしています。

Visual Studio を使用する Azure Functions の開発

前提条件

Azure Functions プロジェクトを作成する

ローカルでアプリの設定を操作する

ローカル開発用のプロジェクトを構成する

プロジェクトに関数を追加する

バインドを追加する

関数をローカルで実行する

Azure に発行する

Function App の設定

Remote Debugging

リモートデバッグに関する考慮事項

デバッガーをアタッチします。

リモートデバッグの無効化

関数の監視

関数のテスト

セットアップ

テストクラスの作成

テストの実行

テストのデバッグ

Azure Functions tools with Visual Studio 2017

Visual Studio 2017 でツールのバージョンを確認する

Visual Studio のツールを更新する

次のステップ

その他のリソース

その他のリソース

Visual Studio を使用する Azure Functions の開発

前提条件

Azure Functions プロジェクトを作成する

ローカルでアプリの設定を操作する

ローカル開発用のプロジェクトを構成する

プロジェクトに関数を追加する

バインドを追加する

関数をローカルで実行する

Azure に発行する

Function App の設定

Remote Debugging

リモート デバッグに関する考慮事項

デバッガーをアタッチします。

リモート デバッグの無効化

関数の監視

関数のテスト

セットアップ

テスト クラスの作成

テストの実行

テストのデバッグ

Azure Functions tools with Visual Studio 2017

Visual Studio 2017 でツールのバージョンを確認する

Visual Studio のツールを更新する

次のステップ

その他のリソース

その他のリソース

リモートデバッグに関する考慮事項

リモートデバッグの無効化

テストクラスの作成