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

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

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

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

前提条件

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

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

• アクティブな 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 トリガー関数テンプレートを選択するか、[スキップ] を選択して関数なしでプロジェクトを作成します。 後でいつでも、プロジェクトに関数を追加できます。

   ヒント

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

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... を実行した場合にのみ取得します。 の コマンドを使用して、既存のプロジェクトに Dockerfile を追加できます。

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

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

定義済みの Functions トリガー テンプレートのいずれかを使用して、既存のプロジェクトに新しい関数を追加できます。 新しい関数トリガーを追加するには、F1 キーを押してコマンド パレットを開き、コマンド Azure Functions: 関数の作成 コマンドを見つけて実行します。 プロンプトに従ってトリガーの種類を選択し、そのトリガーの必要な属性を定義します。 トリガーでサービスに接続するためにアクセス キーまたはconnection stringが必要な場合は、関数トリガーを作成する前にその項目を準備します。

サービスへの接続

入力バインドと出力バインドを追加することで、関数を他の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 MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req)
{

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.Function, "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) {

const { app, output } = require('@azure/functions');

const sendToQueue = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  extraOutputs: [sendToQueue],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());
      context.log(`Name: ${name}`);

      if (name) {
        const msg = `Name passed to the function ${name}`;
        context.extraOutputs.set(sendToQueue, [msg]);
        return { body: msg };
      } else {
        context.log('Missing required data');
        return { status: 404, body: 'Missing required data' };
      }
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

{
  "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"
    }
  ]
}

import {
  app,
  output,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  StorageQueueOutput,
} from '@azure/functions';

const sendToQueue: StorageQueueOutput = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

export async function HttpExample(
  request: HttpRequest,
  context: InvocationContext,
): Promise<HttpResponseInit> {
  try {
    context.log(`Http function processed request for url "${request.url}"`);

    const name = request.query.get('name') || (await request.text());
    context.log(`Name: ${name}`);

    if (name) {
      const msg = `Name passed to the function ${name}`;
      context.extraOutputs.set(sendToQueue, [msg]);
      return { body: msg };
    } else {
      context.log('Missing required data');
      return { status: 404, body: 'Missing required data' };
    }
  } catch (error) {
    context.log(`Error: ${error}`);
    return { status: 500, body: 'Internal Server Error' };
  }
}

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  handler: HttpExample,
});

{
  "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. まだサインインしていない場合は、Activity バーで、Azure アイコンを選択します。 次に、Resources で Sign in to Azure を選択します。

   Visual Studio Code の Azure ウィンドウへのサインイン画面のスクリーンショット

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

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

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

Azure リソースを作成する

Azureに Functions プロジェクトを発行する前に、コードを実行するには、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で連続デプロイメントを設定し、接続されたソースの場所にあるソース ファイルを更新すると、Azureの関数アプリが更新されるようにします。 Visual Studio Codeからプロジェクト ファイルを配置することもできます。 Visual Studio Codeから発行する場合は、Zip デプロイ テクノロジを利用できます。

1. コマンド パレットで、「Azure Functions: Function App にデプロイするを入力して選択します。

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

3. デプロイが完了したら、View Output を選択して、作成したAzure リソースを含む作成とデプロイの結果を表示します。 通知を見逃した場合は、右下隅にあるベル アイコンを選択して、再度確認します。

   [出力の表示] ウィンドウのスクリーンショット。

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

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

1. F1 キーを押してコマンド パレットを開き、コマンド Azure Functions: 関数の URL のコピーを見つけて実行します。

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

クエリ パラメーターで渡された必要なキーとともに、関数の 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 サブスクリプションで関数アプリから実行する関数のショートカット メニューを開き、 [関数を今すぐ実行]を選択します。。

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

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

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

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

Functions ランタイムは、HTTP と webhook を除くすべてのトリガーの種類に対して、Azure Storage アカウントを内部的に使用します。 Values.AzureWebJobsStorage キーを有効なAzure Storage アカウント connection stringに設定します。

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

ストレージ アカウントのconnection stringを設定するには:

1. Visual Studioで、Cloud Explorer を開き、Storage Account>Your Storage Account を展開し、Properties を選択して、Primary Connection String の値をコピーします。

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

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

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

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

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

プロジェクトが実行中の場合は、Execute 関数を今すぐ使用できます。...プロジェクトをAzureに配置する場合と同様に、関数をトリガーする拡張機能の機能。 プロジェクトをデバッグ モードで実行すると、期待どおりにブレークポイントがVisual Studio Codeにヒットします。

1. コマンド パレットで、「Azure Functions: execute function now」と入力し、Local project を選択します。

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

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

ローカルで実行する場合、キーは必要ありません。 この規則は、ファンクション キーと管理者レベルのキーの両方に適用されます。

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

関数アプリをAzureで実行すると、関数に必要な設定はアプリ設定に暗号化されて格納されます。 ローカル開発時に、これらの設定は代わりにlocal.settings.jsonファイルの コレクションに追加されます。 local.settings.json ファイルには、ローカル開発ツールで使用される設定も格納されます。

プロジェクトの Values ファイルの コレクション内の項目は、Azureの関数アプリのアプリケーション設定内の項目をミラーリングすることを目的としています。

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

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

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

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

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

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

アプリケーション設定をアップロードするスクリーンショット。

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

ローカル ファイルが暗号化されている場合、プロセスによって暗号化が解除され、発行され、再び暗号化されます。 競合する値が 2 つの場所に存在する場合は、続行する方法を選択するように求められます。

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

&lgt;c1>&lgt;c0>&lgt;sb0> Visual Studio Codeで関数アプリの設定を表示するためのスクリーンショットです。</sb0>&lgt;/c0>&lgt;/c1>

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)"
    }
}

監視機能

関数を ローカルで実行すると、Core Tools はターミナル コンソールにログ データをストリーム配信します。 Azureの関数アプリで Functions プロジェクトを実行するときにログ データを取得することもできます。 Azureのストリーミング ログに接続して、ほぼリアルタイムのログ データを表示できます。 関数アプリの動作をより完全に理解するには、Application Insights を有効にする必要があります。

Application Insights

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

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

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

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

次のステップ

Azure Functions Core Tools の詳細については、「Work with Azure Functions Core Tools」を参照>。

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