Azure Functions をローカルでコーディングしてテストする

可能な限り、ローカル開発環境で Azure Functions コード プロジェクトを作成して検証する必要があります。 Azure Functions Core Tools には、統合された開発、デバッグ、デプロイ用の一般的な開発ツールと統合された Azure Functions のローカル ランタイム バージョンが用意されています。 ローカル関数は、ライブ Azure サービスに接続することもできます。

この記事では、 local.settings.json ファイルの操作など、ローカル開発に関するいくつかの共有ガイダンスを提供します。 開発環境固有のガイダンスにもリンクされています。

ローカル開発環境

ローカル コンピューター上で関数を開発する方法は、言語とツールの設定によって異なります。 記事の上部にある優先言語を選択してください。

これらの開発環境を使用して、好みの言語で関数をローカルにコーディングできます。

これらの各ローカル開発環境では、関数アプリ プロジェクトを作成し、事前定義の関数テンプレートを使用して新しい関数を作成できます。 各環境では、Core Tools が使用されています。そのため、マシン上の実際の Functions ランタイムに対して、その他のアプリの場合と同様に関数をテストしたり、デバッグしたりできます。 また、これらのどの環境からでも、関数アプリ プロジェクトを Azure に発行できます。

ローカル プロジェクト ファイル

Functions プロジェクト ディレクトリでは、言語に関係なく、次のファイルがプロジェクトのルート フォルダーに含まれます。

プロジェクト内の他のファイルは、言語と特定の関数によって異なります。 詳細については、使用している言語の開発者ガイドを参照してください。

ローカル設定ファイル

local.settings.json ファイルには、ローカル開発ツールで使用されるアプリの設定と設定が格納されます。 local.settings.json ファイルの設定は、プロジェクトをローカルで実行している場合にのみ使用されます。 プロジェクトを Azure に発行するときは、関数アプリのアプリ設定にも必要な設定を必ず追加してください。

local.settings.json ファイルの構造は次のとおりです。

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "<language worker>",
    "AzureWebJobsStorage": "<connection-string>",
    "MyBindingConnection": "<binding-connection-string>",
    "AzureWebJobs.HttpExample.Disabled": "true"
  },
  "Host": {
    "LocalHttpPort": 7071,
    "CORS": "*",
    "CORSCredentials": false
  },
  "ConnectionStrings": {
    "SQLConnectionString": "<sqlclient-connection-string>"
  }
}

これらの設定は、プロジェクトをローカルで実行する場合にサポートされます。

次のアプリケーション設定は、ローカルでの実行時に Values 配列に含めることができます。

設定を同期する

関数をローカルで開発する場合、アプリで必要なローカル設定は、コードがデプロイされる関数アプリのアプリ設定にも存在する必要があります。 関数アプリからローカル プロジェクトに現在の設定をダウンロードする必要がある場合もあります。 Azure portal でアプリ設定を手動で構成できますが、次のツールを使用すると、アプリ設定をプロジェクトのローカル設定と同期することもできます。

• Visual Studio Code
• Visual Studio
• Azure Functions Core Tools

トリガーとバインド

関数をローカルで開発する場合は、トリガーとバインドの動作を考慮する必要があります。 HTTP トリガーの場合は、 http://localhost/を使用して、ローカル コンピューターで HTTP エンドポイントを呼び出すことができます。 HTTP 以外のトリガー関数の場合、ローカルで実行するためのオプションがいくつかあります。

• ローカル開発時にバインディングをテストする最も簡単な方法は、ライブ Azure サービスを対象とする接続文字列を使用することです。 local.settings.json ファイルの Values 配列に適切な接続文字列設定を追加することで、ライブ サービスをターゲットにすることができます。 これを行うと、テスト中のローカル実行が運用サービスに影響を与える可能性があります。 代わりに、開発とテスト中に使用する個別のサービスを設定し、運用環境で別のサービスに切り替える方法を検討してください。
• ストレージ ベースのトリガーの場合は、ローカル ストレージ エミュレーターを使用できます。
• 特別な管理者エンドポイントを使用して、HTTP 以外のトリガー関数を手動で実行できます。 詳細については、「HTTP によって トリガーされていない関数を手動で実行する」を参照してください。

ローカル テスト中は、Core Tools (func.exe) によって提供されるホストをローカルで実行している必要があります。 詳細については、「Azure Functions Core Tools」を参照してください。

HTTP テスト ツール

HTTP の GET メソッドをサポートしていれば、開発中に Web ブラウザーから関数エンドポイントを呼び出すのは簡単です。 ただし、ペイロードをサポートする他の HTTP メソッド (POST や PUT など) の場合は、HTTP テスト ツールを使用して、これらの HTTP 要求を作成し、関数エンドポイントに送信する必要があります。

オフラインまたはローカルで機能する、データをクラウドに同期しない、かつオンライン アカウントにサインインする必要がない HTTP テスト ツールを選択することで、データのセキュリティを確保できます。 特定のセキュリティ機能を実装することで、偶発的な露出からデータを保護できるツールもあります。

HTTP 要求履歴 (機密情報を含む) を一元的に保存している、セキュリティのベスト プラクティスに準拠していない、またはデータのプライバシーに関する懸念を尊重していないようなツールの使用を避けます。

関数エンドポイントに HTTP 要求を安全に送信するには、次のいずれかのツールの使用を検討してください。

• Visual Studio Code を Visual Studio Marketplace にある拡張機能 (REST Client など) と一緒に使用する
• PowerShell Invoke-RestMethod
• Microsoft Edge - ネットワーク コンソール ツール
• Bruno
• curl

ローカル ストレージ エミュレーター

ローカル開発時に、リモート ストレージ サービスに接続しなくても、Azure Storage バインド (Queue Storage、Blob Storage、Table Storage) で関数をテストするときに、ローカル Azurite エミュレーター を使用できます。 Azurite は Visual Studio Code および Visual Studio と統合されており、npm を使用してコマンド プロンプトから実行することもできます。 詳細については、ローカルでの Azure Storage の開発に Azurite エミュレーターを使用する方法に関するページを参照してください。

local.settings.json ファイルのValuesコレクション内の次の設定は、既定の AzureWebJobsStorage の接続に Azurite を使用するようにローカル Functions ホストに指示します。

"AzureWebJobsStorage": "UseDevelopmentStorage=true"

この設定値を使用すると、AzureWebJobsStorage を接続として使用するすべての Azure Storage トリガーまたはバインドが、ローカルで実行されている場合に Azurite に接続されます。 ローカル実行中にストレージ エミュレーションを使用する場合は、次の考慮事項に留意してください。

• Azurite がインストールされ、実行されている必要があります。
• Azure に発行する前に、Azure サービスへの実際のストレージ接続を使用してテストする必要があります。
• プロジェクトを発行するときは、AzureWebJobsStorage 設定を UseDevelopmentStorage=true として発行しないでください。 Azure では、AzureWebJobsStorage 設定は常に、関数アプリで使用されるストレージ アカウントの接続文字列である必要があります。 詳細については、AzureWebJobsStorageを参照してください。

関連資料

• Mac、Linux、または Windows コンピューター上の Visual Studio Code を使用した関数のローカル開発の詳細については、「 Visual Studio Code を使用した Azure Functions の開発」を参照してください。
• コマンド プロンプトまたはターミナルから関数を開発する方法の詳細については、「Work with Azure Functions Core Tools」(Azure Functions Core Tools を使用して作業する) を参照してください。