Visual Studio Code を使用して Azure Functions を開発する

Visual Studio Code 用 Azure Functions 拡張機能を使用すると、関数をローカルで開発して、Azure にデプロイすることができます。 Azure Functions を初めて使用する場合は、詳細について、「Azure Functions の概要」を参照してください。

Azure Functions 拡張機能には、次のような利点があります。

• ローカル開発用コンピューターで関数を編集、作成、および実行できます。
• Azure に直接 Azure Functions プロジェクトを発行できます。
• Visual Studio Code の利点を活用しながら、さまざまな言語で関数を作成できます。

前提条件

• サポートされているプラットフォームのいずれかにインストールされた Visual Studio Code。

• Azure Functions 拡張機能。 Azure リソースの操作に推奨される Azure Tools 拡張機能パックをインストールすることもできます。

• アクティブな Azure サブスクリプション。 まだアカウントを持っていない場合は、Visual Studio Code の拡張機能からアカウントを作成できます。

これらの前提条件は、関数をローカルで実行およびデバッグするためにも必要です。 プロジェクトの作成、または Azure Functions への発行のみの場合は必要ありません。

• Azure Functions Core Tools、統合されたローカル デバッグ エクスペリエンスを有効にします。 Azure Functions 拡張機能がインストールされている場合、Core Tools をインストールまたは更新する最も簡単な方法は、コマンド パレットから Azure Functions: Install or Update Azure Functions Core Tools コマンドを実行することです。

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

Functions の拡張機能により、最初の関数を作成すると共に必要な関数アプリ プロジェクトを作成できます。 これらの手順を用いて、HTTP によってトリガーされる関数を新しいプロジェクトに作成します。 HTTP トリガーは、実演する最も単純な関数トリガー テンプレートです。

1. Visual Studio Code で F1 キーを押してコマンド パレットを開き、コマンド Azure Functions: Create New Project... を検索して実行します。 プロジェクト ワークスペースのディレクトリの場所を選択し、[選択] を選択します。

   プロジェクト ワークスペースには、新しいフォルダーを作成するか、空のフォルダーを選択することができますが、既にワークスペースの一部であるプロジェクト フォルダーは選択しないでください。

   代わりに、Azure Functions: Create New Containerized Project... コマンドを実行して、プロジェクト用に生成された Dockerfile を取得することもできます。

2. 確認のメッセージが表示されたら、プロジェクトの言語を選択します。 必要に応じて、特定の言語バージョンを選択します。

3. HTTP トリガー関数テンプレートを選択するか、 [Skip for now](今はしない) を選択して、関数なしでプロジェクトを作成できます。 後でいつでも、プロジェクトに関数を追加できます。

   ヒント

   [テンプレート フィルターの変更] オプションを選択して、値を [コア] または [すべて] に設定することで、その他のテンプレートを表示できます。

4. 関数名には、HttpExample を入力して Enter キーを選択してから、[関数] の承認を選択します。

   この承認レベルでは、関数エンドポイントを呼び出すときに関数キーを指定する必要があります。

5. ドロップダウン リストから [ワークスペースに追加] を選びます。

6. [このフォルダー内のファイルの作成者を信頼しますか?] ウィンドウで、[はい] を選択します。

Visual Studio Code では、選択した言語と HTTP によってトリガーされる関数のテンプレートで関数が作成されます。

生成されたプロジェクト ファイル

このプロジェクト テンプレートは、選択した言語でプロジェクトを作成し、必要な依存関係をインストールします。 どの言語の場合も、新しいプロジェクトには次のファイルが含まれます。

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

• local.settings.json: 関数をローカルで実行するときに使用される設定を保持します。 これらの設定は、関数をローカルで実行するときにのみ使用されます。 詳細については、「ローカル設定ファイル」を参照してください。

  重要

  local.settings.json ファイルにはシークレットを含めることができるため、それをプロジェクト ソース管理から除外してください。

• Dockerfile (オプション): プロジェクトの承認された基本イメージを使って、プロジェクトからコンテナー化された関数アプリを作成できます。 このファイルを取得するのは、Azure Functions: Create New Containerized Project... コマンドを実行したときだけです。 Core Tools の func init --docker-only コマンドを使って、既存のプロジェクトに Dockerfile を追加できます。

言語に応じて、次のような他のファイルが作成されます。

この時点で、HTTP トリガー関数をローカルで実行できます。

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

定義済みの Functions トリガー テンプレートのいずれかに基づいて、既存のプロジェクトに新しい関数を追加できます。 新しい関数トリガーを追加するには、F1 キーを選択してコマンド パレットを開き、次にコマンド Azure Functions: Create Function を検索して実行します。 プロンプトに従ってトリガーの種類を選択し、そのトリガーの必要な属性を定義します。 トリガーで、サービスに接続するためのアクセス キーまたは接続文字列が必要な場合は、関数トリガーを作成する前にその項目を準備しておいてください。

サービスへの接続

入力および出力バインドを追加すると、関数を他の Azure サービスに接続できます。 バインドを使用すると、接続コードを作成する必要なく、関数を他のサービスに接続できます。

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

次の例は、キュー ストレージの出力バインドを HTTP によってトリガーされる関数に追加した後の関数の定義を示しています。

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req,
    FunctionContext executionContext)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

Azure へのサインイン

Azure リソースを作成したり、アプリを発行したりする前に、Azure にサインインする必要があります。

1. まだサインインしていない場合は、アクティビティ バーの Azure アイコンを選択します。 その後、[リソース] で [Azure にサインイン] を選択します。

   

   既にサインインしていて、既存のサブスクリプションを確認できる場合は、次のセクションに進みます。 Azure アカウントをお持ちでない場合は、[Azure アカウントの作成] を選択します。 学生は、[Microsoft Azure for Students アカウントの作成] を選択できます。

2. ブラウザーでプロンプトが表示されたら、ご利用の Azure アカウントを選択し、その Azure アカウントの資格情報を使用してサインインします。 新しいアカウントを作成した場合は、アカウントの作成後にサインインできます。

3. 正常にサインインしたら、新しいブラウザー ウィンドウを閉じてかまいません。 ご利用の Azure アカウントに属しているサブスクリプションがサイド バーに表示されます。

Azure リソースを作成する

Functions プロジェクトを Azure に発行するには、コードを実行する Azure サブスクリプションに関数アプリおよび関連リソースがあらかじめ存在する必要があります。 関数アプリは、関数の実行コンテキストを提供します。 Visual Studio Code から Azure 内の関数アプリに発行すると、プロジェクトがパッケージ化されて、Azure サブスクリプション内の選択された関数アプリにデプロイされます。

Azure で関数アプリを作成するときは、既定値を使うクイック関数アプリ作成パス、または既存の Azure リソースの使用などの高度なオプションを提供するパスを選択できます。 このようにすることで、作成されるリモート リソースをより細かく制御できます。

Azure Container Apps のデプロイを作成する

Visual Studio Code を使って、コンテナー化されたコード プロジェクト用の Azure リソースを作成します。 この拡張機能は、リソースの作成時に Dockerfile の存在を検出すると、コードだけでなくコンテナー イメージもデプロイするかどうかの確認をユーザーに求めます。 Visual Studio Code は、コンテナー化されたコード プロジェクト用に、Azure Functions と統合された Azure Container Apps 環境を作成します。 詳細については、「Azure Functions の Azure Container Apps ホスティング」を参照してください。

作成プロセスは、クイック作成を選ぶか、詳細オプションを使う必要があるかによって異なります。

Container Apps でコンテナー化された関数を実行するために必要なリソースについて詳しくは、「必要なリソース」をご覧ください。

プロジェクト ファイルのデプロイ

接続されているソースの場所にあるソース ファイルを更新したときに Azure 内の関数アプリが更新されるよう、継続的デプロイを設定することをお勧めします。 Visual Studio Code からプロジェクト ファイルをデプロイすることもできます。 Visual Studio Code から発行するときには、ZIP デプロイ テクノロジを利用できます。

1. コマンド パレットで、入力して [Azure Functions: 関数アプリにデプロイする] を選択します。

2. 作成したばかりの関数アプリを選びます。 前のデプロイの上書きを求められたら、[デプロイ] を選択して、関数コードを新しい関数アプリ リソースにデプロイします。

3. デプロイの完了後、[出力の表示] を選択すると、作成済みの Azure リソースなど、作成とデプロイの結果が表示されます。 通知を見逃した場合は、右下隅にあるベル アイコンを選択して、再度確認します。

   

Azure で HTTP によってトリガーされる関数の URL を取得する

HTTP によってトリガーされる関数をクライアントから呼び出すには、関数アプリにデプロイされた後に使用できる関数の URL が必要です。 この URL には、必要なすべての関数キーが含まれています。 デプロイした関数のこれらの URL を取得するには、拡張機能を使用できます。 Azure でリモート関数を実行するだけの場合は、拡張機能の [Execute function now](今すぐ関数を実行) 機能を使用します。

1. F1 キーを選択してコマンド パレットを開き、コマンド Azure Functions: Copy Function URL を検索して実行します。

2. プロンプトに従って、Azure で関数アプリを選択し、次に、起動する特定の HTTP トリガーを選択します。

code クエリ パラメーターで渡された必要なキーとともに、関数の URL がクリップボードにコピーされます。 HTTP ツールを使って POST 要求を送信するか、ブラウザーを使って GET 要求をリモート関数に送信します。

拡張機能が Azure で関数の URL を取得する場合、拡張機能で Azure アカウントを使用して、関数を開始するために必要なキーが自動的に取得されます。 関数のアクセス キーの詳細を参照してください。 HTTP によってトリガーされない関数を開始するには、管理キーを使用する必要があります。

関数を実行する

Azure Functions 拡張機能を使用すると、個々の関数を実行できます。 ローカルの開発用コンピューター上のプロジェクト内、または Azure サブスクリプション内の関数を実行できます。

HTTP トリガー関数の場合、拡張機能により、HTTP エンドポイントが呼び出されます。 その他の種類のトリガーの場合は、拡張機能で管理者 API が呼び出されて関数が開始されます。 関数に送信される要求のメッセージ本文は、トリガーの種類によって異なります。 トリガーにテスト データが必要な場合、データを特定の JSON 形式で入力するように求められます。

Azure で関数を実行する

Visual Studio Code から Azure 内で関数を実行する場合は、次の手順に従ってください。

1. コマンド パレットで、「Azure Functions: Execute function now」と入力し、Azure サブスクリプションを選択します。

2. 一覧から、Azure 内の関数アプリを選択します。 ご使用の関数アプリが表示されない場合、適正なサブスクリプションにサインインしているかどうか確認してください。

3. 一覧から、実行する関数を選択します。 [Enter request body]\(要求本文を入力してください\) で、要求のメッセージ本文を入力し、Enter キーを押してこの要求メッセージを関数に送信します。

   [Enter request body]\(要求本文を入力してください\) 内の既定のテキストは、本文の形式を示します。 関数アプリに関数が含まれていない場合、このエラーと共に通知エラーが表示されます。

   Azure で関数を実行し、応答が返されると、Visual Studio Code に通知が表示されます。

[Azure: Functions] 領域から関数を実行することもできます。このためには、Azure サブスクリプション内の関数アプリから実行する関数のショートカット メニューを開き、[Execute function now...] (今すぐ関数を実行...) を選択します。

Visual Studio Code から Azure で関数を実行する場合、拡張機能により、Azure アカウントを使用して、関数を開始するために必要なキーが自動的に取得されます。 関数のアクセス キーの詳細を参照してください。 HTTP によってトリガーされない関数を開始するには、管理キーを使用する必要があります。

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

ローカル ランタイムは、Azure で関数アプリをホストしているのと同じランタイムです。 ローカル設定は、local.settings.json ファイルから読み取られます。 Functions プロジェクトをローカルで実行するには、追加要件を満たす必要があります。

ローカルで実行するようにプロジェクトを構成する

Functions ランタイムは、HTTP と Webhook を除くすべてのトリガーの種類に対して内部で Azure Storage アカウントを使用します。 したがって、Values.AzureWebJobsStorage キーを、有効な Azure Storage アカウントの接続文字列に設定する必要があります。

このセクションでは、Visual Studio Code 用の Azure Storage 拡張機能を Azure Storage Explorer と共に使用して、ストレージ接続文字列の接続と取得を行います。

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

1. Visual Studio で Cloud Explorer を開き、[ストレージ アカウント]>[Your Storage Account]\(自分のストレージ アカウント\) を展開し、[プロパティ] を選択し、[プライマリ接続文字列] 値をコピーします。

2. プロジェクトで、local.settings.json ファイルを開き、コピーした接続文字列に AzureWebJobsStorage キーの値を設定します。

3. 前の手順を繰り返し、関数に必要なその他のすべての接続について、Values 配列に一意のキーを追加します。

詳細については、「ローカル設定ファイル」を参照してください。

関数をローカルでデバッグする

関数をデバッグするには、F5 キーを選択します。 Core Tools が利用可能でない場合は、これをインストールするように求められます。 Core Tools がインストールされて実行されると、ターミナルに出力が表示されます。 この手順は、func start Core Tools コマンドをターミナルから実行するのと同じですが、追加のビルド タスクと、接続されたデバッガーが含まれます。

プロジェクトが実行されている場合、プロジェクトが Azure にデプロイされている場合と同様に、拡張機能の [Execute function now](今すぐ関数を実行) 機能を使用して関数をトリガーできます。 プロジェクトがデバッグ モードで実行されている場合は、予期したとおりに Visual Studio Code でブレークポイントがヒットします。

1. コマンド パレットで 「Azure Functions: Execute function now」と入力し、[ローカル プロジェクト] を選択します。

2. プロジェクトで実行する関数を選択して、 [Enter request body](要求本文を入力してください) に要求のメッセージ本文を入力します。 Enter キーを押して、この要求メッセージを関数に送信します。 [Enter request body](要求本文を入力してください) 内の既定のテキストは、本文の形式を示します。 関数アプリに関数が含まれていない場合、このエラーと共に通知エラーが表示されます。

3. 関数をローカルで実行する場合、応答を受け取ると、Visual Studio Code で通知が発生します。 関数の実行に関する情報は、 [ターミナル] パネルに表示されます。

ローカルで実行する場合、キーは必要ありません。これは、関数キーと管理者レベルのキーの両方に適用されます。

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

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

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

既定では、プロジェクトが Azure に発行されても、これらの設定は自動的に移行されません。 発行が完了すると、local.settings.json から Azure の関数アプリに設定を発行するオプションが提供されます。 詳細については、「アプリケーション設定を発行する」を参照してください。

ConnectionStrings 内の値は発行されません。

Azure のアプリケーション設定

プロジェクトでの local.settings.json ファイルの設定は、Azure の関数アプリのアプリケーション設定と同じである必要があります。 local.settings.json に追加したすべての設定は、Azure の関数アプリにも追加する必要があります。 プロジェクトを発行するときに、これらの設定は自動的にアップロードされません。 同様に、ポータル内の関数アプリで作成する設定はすべて、ローカル プロジェクトにダウンロードする必要があります。

アプリケーション設定を発行する

Azure の関数アプリに必要な設定を発行する最も簡単な方法は、プロジェクトが発行された後に表示される [Upload settings](設定のアップロード) リンクを使用することです。

設定を発行するには、Azure Functions: Upload Local Setting コマンド (コマンド パレット) を使用することもできます。 Azure のアプリケーション設定に個々の設定を追加するには、Azure Functions: Add New Setting コマンドを使用します。

ローカル ファイルが暗号化されている場合は、復号化され、発行されて、再び暗号化されます。 2 つの場所で値が競合する設定がある場合は、続行する方法を選択するように求められます。

既存のアプリ設定を Azure: Functions 領域で表示するには、サブスクリプション、関数アプリ、 [アプリケーション設定] を展開します。

Azure から設定をダウンロードする

Azure でアプリケーション設定を作成した場合は、 コマンド「Azure Functions:Download Remote Settings」を使用してそれらを local.settings.json ファイルにダウンロードできます。

アップロードと同様に、ローカル ファイルが暗号化されている場合は、復号化され、更新されて、再び暗号化されます。 2 つの場所で値が競合する設定がある場合は、続行する方法を選択するように求められます。

バインディング拡張機能をインストールする

HTTP トリガーとタイマー トリガーを除き、バインドは拡張機能パッケージで実装されます。

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

dotnet add package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.*, 4.0.0)"
    }
}

関数の監視

関数をローカルで実行しているときは、ログ データがターミナル コンソールにストリーミングされます。 また、Functions プロジェクトが Azure の関数アプリで実行されているときにもログ データを取得できます。 Azure 内のストリーミング ログに接続すると、ほぼリアルタイムのログ データを確認できます。 関数アプリの動作をより完全に把握するために Application Insights を有効にすることをお勧めします。

Application Insights

関数アプリを Application Insights と統合することによって、関数の実行を監視することをお勧めします。 Azure portal で関数アプリを作成する場合、この統合は、既定で行われます。 Visual Studio の発行中に関数アプリを作成する場合は、Application Insights を自分で統合する必要があります。 方法については、「Application Insights との統合を有効にする」を参照してください。

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

コマンド パレットのリファレンス

Azure Functions 拡張機能には、Azure の関数アプリと対話するための領域に便利なグラフィカル インターフェイスが用意されています。 同じ機能が、コマンド パレット (F1) のコマンドとしても使用できます。 これらの Azure Functions コマンドを使用できます。

次のステップ

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

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