クイック スタート: TypeScript Durable Functions アプリを作成する

• Visual Studio Code の拡張機能である Azure Functions がインストールされている。

• Visual Studio Code 拡張機能 Azure Functions バージョン 1.10.4 以降がインストールされている。

• 最新バージョンの Azure Functions Core Tools がインストールされていること。

• Azure Functions Core Tools バージョン 4.0.5382 以降がインストールされている。

• Node.js バージョン 16.x 以降がインストールされている。

• Node.js バージョン 18.x 以降がインストールされている。

3. プロンプトで、次の情報を指定します。

   Prompt	アクション	説明
   関数アプリ プロジェクトの言語を選択してください	[TypeScript] を選択します。	TypeScript を使ってローカル Node.js 関数プロジェクトを作成します。
   JavaScript プログラミング モデルを選択する	[モデル V3] を選択します。	v3 プログラミング モデルを設定します。
   バージョンを選択してください	[Azure Functions v4] を選択します。	このオプションは、Core Tools がまだインストールされていない場合にのみ表示されます。 その場合、アプリの初回実行時に Core Tools がインストールされます。
   Select a template for your project's first function (プロジェクトの最初の関数のテンプレートを選択してください)	[後で確認する] を選択します。
   Select how you would like to open your project (プロジェクトを開く方法を選択してください)	[Open in current window] (現在のウィンドウで開く) を選択します。	選択されたフォルダーで Visual Studio Code を開きます。

3. プロンプトで、次の情報を指定します。

   Prompt	アクション	説明
   関数アプリ プロジェクトの言語を選択してください	[TypeScript] を選択します。	TypeScript を使ってローカル Node.js 関数プロジェクトを作成します。
   JavaScript プログラミング モデルを選択する	[モデル V4] を選択します。	v4 プログラミング モデルを設定します。
   バージョンを選択してください	[Azure Functions v4] を選択します。	このオプションは、Core Tools がまだインストールされていない場合にのみ表示されます。 その場合、アプリの初回実行時に Core Tools がインストールされます。
   Select a template for your project's first function (プロジェクトの最初の関数のテンプレートを選択してください)	[後で確認する] を選択します。
   Select how you would like to open your project (プロジェクトを開く方法を選択してください)	[Open in current window] (現在のウィンドウで開く) を選択します。	選択されたフォルダーで Visual Studio Code を開きます。

v4 プログラミング モデルを使用するには、durable-functions ライブラリのプレビュー v3.x バージョンをインストールする必要があります。

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

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

オーケストレーター関数

テンプレートを使用してプロジェクト内に Durable Functions コードを作成します。

1. コマンド パレットで、入力して [Azure Functions: 関数を作成する] を選択します。

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

   Prompt	アクション	説明
   Select a template for your function (関数のテンプレートを選択してください)	[Durable Functions オーケストレーター] を選択します。	Durable Functions オーケストレーションを作成します。
   永続ストレージの種類を選択してください	[Azure Storage (既定値)] を選択します。	Durable Functions アプリに使用するストレージ バックエンドを設定します。
   Provide a function name (関数名を指定してください)	「HelloOrchestrator」と入力します。	関数の名前。

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

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

アクティビティ関数

1. コマンド パレットで、入力して [Azure Functions: 関数を作成する] を選択します。

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

   Prompt	アクション	説明
   Select a template for your function (関数のテンプレートを選択してください)	[Durable Functions のアクティビティ] を選択します。	アクティビティ関数を作成します。
   Provide a function name (関数名を指定してください)	「Hello」と入力します。	アクティビティ関数の名前。

オーケストレーターによって呼び出される Hello アクティビティ関数を追加しました。 Hello/index.ts を開いて、それが入力として名前を受け取り、あいさつを返すことを確認します。 アクティビティ関数は、データベース呼び出しの実行や非決定的な計算の実行など、ワークフローで "実際の作業" を実行する場所です。

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

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

1. コマンド パレットで、「Azure Functions: Create Function」と入力して選択します。

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

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

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

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

v4 プログラミング モデルの利点の 1 つは、関数を記述する場所の柔軟性です。 v4 モデルでは、1 つのテンプレートを使用して、プロジェクト内の 1 つのファイルで 3 つの関数すべてを作成できます。

1. コマンド パレットで、入力して [Azure Functions: 関数を作成する] を選択します。

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

   Prompt	アクション	説明
   Select a template for your function (関数のテンプレートを選択してください)	[Durable Functions オーケストレーター] を選択します。	Durable Functions アプリ オーケストレーション、アクティビティ関数、永続クライアント スターター関数を含むファイルを作成します。
   永続ストレージの種類を選択してください	[Azure Storage (既定値)] を選択します。	永続的な関数に使用するストレージ バックエンドを設定します。
   Provide a function name (関数名を指定してください)	「Hello」と入力します。	Durable Function の名前。

src/functions/hello.ts を開き、作成した関数を表示します。

アクティビティ関数を調整する helloOrchestrator という名前のオーケストレーターを作成しました。 context.df.callActivity を呼び出すたびに、hello という名前のアクティビティ関数が呼び出されます。

また、オーケストレーターによって呼び出される hello アクティビティ関数を追加しました。 同じファイルで、これが入力として名前を受け取って、あいさつを返していることが分かります。 アクティビティ関数は、データベース呼び出しの実行や非決定的な計算の実行など、ワークフローで "実際の作業" を実行する場所です。

最後に、オーケストレーションを開始する、HTTP によってトリガーされる関数を追加しました。 同じファイルで、client.startNew を使用して新しいオーケストレーションを開始していることがわかります。 次に、client.createCheckStatusResponse を使用して HTTP 応答が返されます。その応答には、新しいオーケストレーションを監視および管理するために使用できる URL が含まれています。

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

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

   Note

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

1. 関数をテストするには、hello アクティビティ関数のコード (src/functions/hello.ts 内) にブレークポイントを設定します。 F5 キーを押すか、コマンド パレットで [デバッグ: デバッグの開始] を選択して、関数アプリ プロジェクトを開始します。 Core Tools の出力がターミナル パネルに表示されます。

   Note

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

5. ご使用のブラウザーまたは次のいずれかの HTTP テスト ツールを使用して、URL エンドポイントに HTTP POST 要求を送信します。

   • Visual Studio Code を Visual Studio Marketplace からの拡張機能と一緒に使用する
   • PowerShell Invoke-RestMethod
   • Microsoft Edge - ネットワーク コンソール ツール
   • Bruno
   • curl

   注意事項

   資格情報、シークレット、アクセス トークン、API キーなどの機密データがあるシナリオでは、必要なセキュリティ機能でデータを保護したうえで、ツールは必ずオフラインまたはローカルで動作し、データをクラウドに同期せず、オンライン アカウントにサインインする必要がないものを使用してください。 このようにすることで、機密データを一般に公開するリスクを軽減できます。

   最後のセグメントをオーケストレーター関数の名前 (HelloOrchestrator) に置き換えます。 この URL は http://localhost:7071/api/orchestrators/HelloOrchestrator のようになります。

   応答は、HTTP 関数の最初の結果です。 これは、持続的オーケストレーションが正常に開始されたことを知らせます。 オーケストレーションの最終的な結果はまだ表示されません。 応答には、いくつかの便利な URL が含まれています。 ここでは、オーケストレーションの状態のクエリを実行します。

5. ご使用のブラウザーまたは次のいずれかの HTTP テスト ツールを使用して、URL エンドポイントに HTTP POST 要求を送信します。

   • Visual Studio Code を Visual Studio Marketplace からの拡張機能と一緒に使用する
   • PowerShell Invoke-RestMethod
   • Microsoft Edge - ネットワーク コンソール ツール
   • Bruno
   • curl

   注意事項

   資格情報、シークレット、アクセス トークン、API キーなどの機密データがあるシナリオでは、必要なセキュリティ機能でデータを保護したうえで、ツールは必ずオフラインまたはローカルで動作し、データをクラウドに同期せず、オンライン アカウントにサインインする必要がないものを使用してください。 このようにすることで、機密データを一般に公開するリスクを軽減できます。

   最後のセグメントをオーケストレーター関数の名前 (HelloOrchestrator) に置き換えます。 この URL は http://localhost:7071/api/orchestrators/HelloOrchestrator のようになります。

   応答は、HTTP 関数の最初の結果です。 これは、持続的オーケストレーションが正常に開始されたことを知らせます。 オーケストレーションの最終的な結果はまだ表示されません。 応答には、いくつかの便利な URL が含まれています。 ここでは、オーケストレーションの状態のクエリを実行します。

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

   この要求によって、オーケストレーション インスタンスの状態が照会されます。 これでインスタンスが完了し、Durable Function の出力または結果が含まれていることがわかります。 これは、次の例のようになります。

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

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

   この要求によって、オーケストレーション インスタンスの状態が照会されます。 インスタンスが完了し、Durable Functions アプリの出力または結果が含まれていることがわかります。 これは、次の例のようになります。

   {
       "name": "helloOrchestrator",
       "instanceId": "6ba3f77933b1461ea1a3828c013c9d56",
       "runtimeStatus": "Completed",
       "input": "",
       "customStatus": null,
       "output": [
           "Hello, Tokyo",
           "Hello, Seattle",
           "Hello, Cairo"
       ],
       "createdTime": "2023-02-13T23:02:21Z",
       "lastUpdatedTime": "2023-02-13T23:02:25Z"
   }
   

1. 出力パネルから HTTP トリガーの URL をコピーします。 HTTP によってトリガーされる関数を呼び出す URL は、次の形式であることが必要です。

   https://<functionappname>.azurewebsites.net/api/orchestrators/HelloOrchestrator

1. 出力パネルから HTTP トリガーの URL をコピーします。 HTTP によってトリガーされる関数を呼び出す URL は、次の形式であることが必要です。

   https://<functionappname>.azurewebsites.net/api/orchestrators/helloOrchestrator