JavaScript で最初の Durable Functions を作成する

Durable Functions は、サーバーレス環境でステートフル関数を記述できる Azure Functions の拡張機能です。 この拡張機能は状態、チェックポイント、再起動を管理します。

この記事では、Visual Studio Code Azure Functions 拡張機能を使用して、"hello world" Durable Functions をローカルで作成してテストする方法について説明します。 この関数は、他の関数の呼び出しを調整し、連結します。 その後、関数コードを Azure に発行します。

Azure で Durable Functions を実行する

前提条件

このチュートリアルを完了するには、以下が必要です。

  • Visual Studio Code をインストールします。

  • Azure Functions VS Code 拡張機能をインストールします。

  • 最新バージョンの Azure Functions Core Tools があることを確認します。

  • Durable Functions には Azure ストレージ アカウントが必要です。 Azure サブスクリプションが必要です。

  • Node.js のバージョン 10.x または 12.x がインストールされていることを確認します。

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

ローカル プロジェクトを作成する

このセクションでは、Visual Studio Code を使用して、ローカル Azure Functions プロジェクトを作成します。

  1. Visual Studio Code で、F1 (または Ctrl/Cmd + Shift + P) キーを押してコマンド パレットを開きます。 コマンド パレットで、Azure Functions: Create New Project... を検索して選択します。

    関数の作成

  2. プロジェクト用に空のフォルダーの場所を選択し、 [選択] を選択します。

  3. プロンプトに従って、次の情報を入力します。

    Prompt 説明
    Select a language for your function app project (関数アプリ プロジェクトの言語を選択してください) JavaScript ローカル Node.js 関数プロジェクトを作成します。
    Select a version (バージョンを選択してください) Azure Functions v3 このオプションが表示されるのは、Core Tools がまだインストールされていない場合だけです。 その場合、アプリの初回実行時に Core Tools がインストールされます。
    Select a template for your project's first function (プロジェクトの最初の関数のテンプレートを選択してください) 今はしない
    Select how you would like to open your project (プロジェクトを開く方法を選択してください) 現在のウィンドウで開く 選択したフォルダーで VS Code を開き直します。

Azure Functions Core Tools は、必要に応じて Visual Studio Code によりインストールされます。 また、関数アプリ プロジェクトがフォルダーに作成されます。 このプロジェクトには、host.json および local.settings.json 構成ファイルが含まれています。

また、ルート フォルダーには、package.json ファイルが作成されます。

Durable Functions npm パッケージをインストールする

Node.js 関数アプリで Durable Functions を使用して作業するには、durable-functions というライブラリを使用します。

  1. [表示] メニューまたは Ctrl + Shift + ' キーを使用して、VS Code で新しいターミナルを開きます。

  2. 関数アプリのルート ディレクトリで npm install durable-functions を実行して、durable-functions npm パッケージをインストールします。

関数を作成する

最も基本的な Durable Functions アプリには、3 つの関数が含まれています。

  • "オーケストレーター関数" - 他の関数を調整するワークフローを記述します。
  • "アクティビティ関数" - オーケストレーター関数によって呼び出され、作業を実行し、必要に応じて値を返します。
  • クライアント関数 - オーケストレーター関数を開始する通常の Azure Functions。 この例では、HTTP によってトリガーされる関数を使用しています。

オーケストレーター関数

テンプレートを使用してプロジェクト内に永続関数のコードを作成します。

  1. コマンド パレットで、Azure Functions: Create Function... を検索して選択します。

  2. プロンプトに従って、次の情報を入力します。

    Prompt 説明
    Select a template for your function (関数のテンプレートを選択してください) Durable Functions オーケストレーター Durable Functions オーケストレーションを作成します
    Provide a function name (関数名を指定してください) HelloOrchestrator 持続的な関数の名前

アクティビティ関数を調整するオーケストレーターを追加しました。 HelloOrchestrator/index.js を開いて、オーケストレーター関数を確認します。 context.df.callActivity を呼び出すたびに、Hello という名前のアクティビティ関数が呼び出されます。

次に、参照先の Hello アクティビティ関数を追加します。

アクティビティ関数

  1. コマンド パレットで、Azure Functions: Create Function... を検索して選択します。

  2. プロンプトに従って、次の情報を入力します。

    Prompt 説明
    Select a template for your function (関数のテンプレートを選択してください) Durable Functions のアクティビティ アクティビティ関数を作成する
    Provide a function name (関数名を指定してください) こんにちは アクティビティ関数の名前

オーケストレーターによって呼び出される Hello アクティビティ関数を追加しました。 Hello/index.js を開いて、それが入力として名前を受け取り、あいさつを返すことを確認します。 アクティビティ関数では、データベース呼び出しや計算の実行などのアクションを実行します。

最後に、オーケストレーションを開始する、HTTP によってトリガーされる関数を追加します。

クライアント関数 (HTTP スターター)

  1. コマンド パレットで、Azure Functions: Create Function... を検索して選択します。

  2. プロンプトに従って、次の情報を入力します。

    Prompt 説明
    Select a template for your function (関数のテンプレートを選択してください) Durable Functions HTTP スターター HTTP スターター関数を作成する
    Provide a function name (関数名を指定してください) DurableFunctionsHttpStart アクティビティ関数の名前
    承認レベル Anonymous デモの目的で、認証を使用せずに関数を呼び出すことができるようにします。

オーケストレーションを開始する、HTTP によってトリガーされる関数を追加しました。 DurableFunctionsHttpStart/index.js を開いて、client.startNew を使用して新しいオーケストレーションが開始されていることを確認します。 次に、client.createCheckStatusResponse を使用して HTTP 応答が返されます。その応答には、新しいオーケストレーションを監視および管理するために使用できる URL が含まれています。

これで、ローカルで実行して Azure にデプロイできる Durable Functions アプリが作成されました。

関数をローカルでテストする

Azure Functions Core Tools を使用すると、ローカルの開発用コンピューター上で Azure Functions プロジェクトを実行できます。 Visual Studio Code から初めて関数を起動すると、これらのツールをインストールするよう求めるメッセージが表示されます。

  1. 関数をテストするには、Hello アクティビティ関数のコード (Hello/index.js) にブレークポイントを設定します。 F5 キーを押すか、コマンド パレットから Debug: Start Debugging を選択して、関数アプリ プロジェクトを開始します。 Core Tools からの出力が ターミナル パネルに表示されます。

    注意

    デバッグについて詳しくは、Durable Functions の診断に関する記事をご覧ください。

  2. Durable Functions を実行するには Azure ストレージ アカウントが必要です。 VS Code でストレージ アカウント選択のプロンプトが表示されたら、 [ストレージ アカウントの選択] を選択します。

    ストレージ アカウントの作成

  3. プロンプトに従って次の情報を入力し、Azure で新しいストレージ アカウントを作成します。

    Prompt 説明
    サブスクリプションの選択 <お使いのサブスクリプションの名前> Azure サブスクリプションを選択します。
    Select a storage account (ストレージ アカウントを選択する) 新しいストレージ アカウントの作成
    Enter the name of the new storage account (新しいストレージ アカウントの名前を入力する) <一意の名前> 作成するストレージ アカウントの名前
    リソース グループの選択 <一意の名前> 作成するリソース グループの名前
    場所を選択します。 リージョン 近くのリージョンを選択します
  4. ターミナル パネルで、HTTP によってトリガーされる関数の URL エンドポイントをコピーします。

    Azure のローカル出力

  5. ブラウザーもしくは、Postman または cURL のようなツールを使用して、HTTP POST 要求を URL エンドポイントに送信します。 最後のセグメントをオーケストレーター関数の名前 (HelloOrchestrator) に置き換えます。 この URL は http://localhost:7071/api/orchestrators/HelloOrchestrator のようになります。

    応答は、永続的なオーケストレーションが正常に開始されたことを示す HTTP 関数の最初の結果です。 これはまだオーケストレーションの最終的な結果ではありません。 応答には、いくつかの便利な URL が含まれています。 ここでは、オーケストレーションの状態を照会してみましょう。

  6. statusQueryGetUri の URL 値をコピーし、ブラウザーのアドレス バーに貼り付け、要求を実行します。 また、引き続き Postman を使用して GET 要求を発行することもできます。

    この要求によって、オーケストレーション インスタンスの状態が照会されます。 インスタンスが完了したことを示し、持続的な関数の出力または結果を含む、最終的な応答を受け取ります。 次のように表示されます。

    {
        "name": "HelloOrchestrator",
        "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a",
        "runtimeStatus": "Completed",
        "input": null,
        "customStatus": null,
        "output": [
            "Hello Tokyo!",
            "Hello Seattle!",
            "Hello London!"
        ],
        "createdTime": "2020-03-18T21:54:49Z",
        "lastUpdatedTime": "2020-03-18T21:54:54Z"
    }
    
  7. デバッグを停止するには、VS Code で Shift キーを押しながら F5 キー を押します。

関数がローカル コンピューター上で正常に動作することを確認したら、プロジェクトを Azure に発行します。

Azure へのサインイン

アプリを発行するには、Azure にサインインしておく必要があります。

  1. まだサインインしていない場合は、アクティビティ バーの Azure アイコンを選択し、 [Azure: Functions] 領域で、 [Azure にサインイン...] を選択します。アカウントがない場合は、 無料の Azure アカウントを作成する ことができます。 学生は、 無料の Azure for Students アカウントを作成する ことができます。

    VS Code 内で Azure にサインインする

    既にサインインしている場合は、次のセクションに進んでください。

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

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

Azure にプロジェクトを発行する

このセクションでは、ご利用の Azure サブスクリプションに関数アプリと関連リソースを作成し、コードをデプロイします。

重要

既存の関数アプリに発行すると、Azure のそのアプリのコンテンツが上書きされます。

  1. アクティビティ バーの Azure アイコンを選択し、 [Azure: Functions] 領域で、 [Deploy to function app](関数アプリにデプロイ) ボタンを選択します。

    プロジェクトを Azure に発行する

  2. プロンプトで、次の情報を入力します。

    • Select folder (フォルダーを選択してください) : ワークスペースのフォルダーを選択するか、関数アプリが格納されているフォルダーを参照します。 既に有効な関数アプリが開いている場合には、このプロンプトは表示されません。

    • Select subscription (サブスクリプションを選択してください) : 使用するサブスクリプションを選択します。 サブスクリプションが 1 つのみの場合、このプロンプトは表示されません。

    • Select function app in Azure (Azure で関数アプリを選択してください) : [- Create new Function App] を選択します。 (Advanced オプションはこの記事では取り上げません。選択しないでください。)

    • Enter a globally unique name for the function app (関数アプリのグローバルに一意の名前を入力します) : URL パスに有効な名前を入力します。 入力した名前は、Azure Functions 内での一意性を確保するために検証されます。

    • Select a location for new resources (新しいリソースの場所を選択してください) : パフォーマンスを向上させるために、お近くの リージョンを選択してください。

    この拡張機能は、Azure に作成されている個々のリソースの状態を通知領域に表示します。

    Azure リソース作成の通知

  3. 完了すると、関数アプリ名に基づく名前を使用して、次の Azure リソースがサブスクリプションに作成されます。

    • リソース グループ。関連リソースの論理コンテナーです。
    • Standard Azure ストレージ アカウント。プロジェクトについての状態とその他の情報を保持します。
    • 従量課金プラン。サーバーレス関数アプリの実行環境となるホストを定義します。
    • 関数アプリ。関数コードを実行するための環境となります。 関数アプリを使用すると、同じホスティング プランに含まれるリソースの管理、デプロイ、共有を容易にするための論理ユニットとして関数をグループ化できます。
    • 関数アプリに接続された Application Insights インスタンス。サーバーレス関数の使用を追跡します。

    関数アプリが作成され、展開パッケージが適用されると、通知が表示されます。

    ヒント

    既定では、関数アプリに必要な Azure リソースが、指定した関数アプリ名に基づいて作成されます。 また、既定では、関数アプリを含んだ同じ新しいリソース グループがその作成先となります。 それらのリソースの名前をカスタマイズしたり、既存のリソースを再利用したりする場合は、高度な作成オプションを使用してプロジェクトを発行する必要があります。

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

    作成完了通知

Azure で関数をテストする

  1. 出力 パネルから HTTP トリガーの URL をコピーします。 HTTP によってトリガーされる関数を呼び出す URL は、次の形式である必要があります: http://<functionappname>.azurewebsites.net/api/orchestrators/HelloOrchestrator

  2. HTTP 要求のこの新しい URL をブラウザーのアドレス バーに貼り付けます。 以前の発行済みアプリの使用時と同じ状態応答を受け取るはずです。

次のステップ

Visual Studio Code を使用して、JavaScript の Durable Functions アプリを作成して発行しました。