Python で最初の永続関数を作成する

[アーティクル]
04/17/2023

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

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

Azure で実行中の Durable Functions スクリーンショット。

前提条件

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

Visual Studio Code をインストールします。
Azure Functions Visual Studio Code 拡張機能をインストールします。
最新バージョンの Azure Functions Core Tools があることを確認します。
Durable Functions には Azure ストレージアカウントが必要です。 Azure サブスクリプションが必要です。
Python のバージョン 3.7、3.8、3.9、または 3.10 がインストールされていることを確認します。

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

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

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

Visual Studio Code で、F1 (または Ctrl または Cmd + Shift + P) キーを押して、コマンドパレットを開きます。コマンドパレットで、Azure Functions: Create New Project... を検索して選択します。
プロジェクト用に空のフォルダーの場所を選択し、 [選択] を選択します。

プロンプトに従って、次の情報を指定します。

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

プロンプトに従って、次の情報を指定します。

Prompt	値	説明
言語を選択する	Python (プログラミングモデル V2)	V2 プログラミングモデルを使用して、ローカル Python Functions プロジェクトを作成します。
Select a version (バージョンを選択してください)	Azure Functions v4	このオプションが表示されるのは、Core Tools がまだインストールされていない場合だけです。その場合、アプリの初回実行時に Core Tools がインストールされます。
Python バージョン	Python 3.7、3.8、3.9、または 3.10	Visual Studio Code により、選択したバージョンの仮想環境が作成されます。
Select how you would like to open your project (プロジェクトを開く方法を選択してください)	現在のウィンドウで開く	選択したフォルダーで Visual Studio Code を開き直します。

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

また、ルートフォルダーに requirements.txt ファイルが作成されます。関数アプリを実行するために必要な Python パッケージを指定します。

PyPI からの azure-functions-durable のインストール

プロジェクトを作成すると、Azure Functions Visual Studio Code 拡張機能によって、選択した Python バージョンの仮想環境が自動的に作成されます。次に、ターミナルで仮想環境をアクティブ化し、Azure Functions と Durable Functions に必要ないくつかの依存関係をインストールする必要があります。

エディターで requirements.txt を開き、内容を次のコードのように変更します。
```
azure-functions
azure-functions-durable
```
現在のフォルダーで、エディターの統合ターミナルを開きます (Ctrl + Shift + ` キー)。
統合ターミナルで、ご使用のオペレーティングシステムに応じて現在のフォルダーの仮想環境をアクティブにします。
- Linux
- MacOS
- Windows
```
source .venv/bin/activate
```
```
source .venv/bin/activate
```
```
.venv\scripts\activate
```
仮想環境がアクティブになっている統合ターミナルで pip を使用して、定義したパッケージをインストールします。
```
python -m pip install -r requirements.txt
```

関数を作成する

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

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

オーケストレーター関数

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

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

プロンプトに従って、次の情報を指定します。

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

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

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

アクティビティ関数

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

プロンプトに従って、次の情報を指定します。

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

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

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

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

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

プロンプトに従って、次の情報を指定します。

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

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

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

必要条件

Python プログラミングモデルのバージョン 2 には、次の最小バージョンが必要です。

Azure Functions Runtime v4.16 以降
Azure Functions Core Tools v4.0.5095+ 以降 (ローカルで実行する場合)
azure-functions-durable v1.2.4+

v2 プログラミングモデルを有効にする

v2 プログラミングモデルを実行するには、次のアプリケーション設定が必要です:

名前: AzureWebJobsFeatureFlags
値: EnableWorkerIndexing

Azure Functions Core Tools を使ってローカルで実行している場合は、この設定を local.settings.json ファイルに追加する必要があります。 Azure で実行している場合は、選んだツールを使って以下の手順を実行します。

<FUNCTION_APP_NAME> と <RESOURCE_GROUP_NAME> を実際の関数アプリとリソースグループの名前でそれぞれ置き換えます。

az functionapp config appsettings set --name <FUNCTION_APP_NAME> --resource-group <RESOURCE_GROUP_NAME> --settings AzureWebJobsFeatureFlags=EnableWorkerIndexing

<FUNCTION_APP_NAME> と <RESOURCE_GROUP_NAME> を実際の関数アプリとリソースグループの名前でそれぞれ置き換えます。

Update-AzFunctionAppSetting -Name <FUNCTION_APP_NAME> -ResourceGroupName <RESOURCE_GROUP_NAME> -AppSetting @{"AzureWebJobsFeatureFlags" = "EnableWorkerIndexing"}

VS Code 用 Azure Functions 拡張機能がインストールされていることを確認します
F1 キーを押してコマンドパレットを開きます。コマンドパレットで、Azure Functions: Add New Setting... を検索して選択します。
プロンプトが表示されたら、サブスクリプションと関数アプリを選びます
名前には「AzureWebJobsFeatureFlags」と入力し、Enter キーを押します。
値には EnableWorkerIndexing と入力し、Enter キーを押します。

これらの 3 つの関数型を使用して基本的な Durable Functions アプリを作成するには、function_app.py の内容を次の Python コードに置き換えます。

import azure.functions as func
import azure.durable_functions as df

myApp = df.DFApp(http_auth_level=func.AuthLevel.ANONYMOUS)

# An HTTP-Triggered Function with a Durable Functions Client binding
@myApp.route(route="orchestrators/{functionName}")
@myApp.durable_client_input(client_name="client")
async def http_start(req: func.HttpRequest, client):
    function_name = req.route_params.get('functionName')
    instance_id = await client.start_new(function_name)
    response = client.create_check_status_response(req, instance_id)
    return response

# Orchestrator
@myApp.orchestration_trigger(context_name="context")
def hello_orchestrator(context):
    result1 = yield context.call_activity("hello", "Seattle")
    result2 = yield context.call_activity("hello", "Tokyo")
    result3 = yield context.call_activity("hello", "London")

    return [result1, result2, result3]

# Activity
@myApp.activity_trigger(input_name="city")
def hello(city: str):
    return f"Hello {city}"

サンプル内の各関数とその目的の説明については、下の表を参照してください。

メソッド	説明
`hello_orchestrator`	ワークフローを記述するオーケストレーター関数。この場合、オーケストレーションが開始され、シーケンス内で 3 つの関数が呼び出され、リスト内の 3 つすべての関数の順序付けられた結果が返されます。
`hello`	オーケストレーション対象の作業を実行するアクティビティ関数。関数は、引数として渡された市区町村に簡単なあいさつ文を返します。
`http_start`	オーケストレーションのインスタンスを開始し、チェック状態の応答を返す、HTTP によってトリガーされる関数。

Note

Durable Functions では、Python V2 のブループリントもサポートされています。これらを使用するには、こちらに示すように、azure-functions-durableBlueprint クラスを使用してブループリント関数を登録する必要があります。その後、結果のブループリントを通常どおりに登録できます。例については、サンプルをご覧ください。

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

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

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

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

Note

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

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

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

Prompt	値	説明
サブスクリプションの選択	<お使いのサブスクリプションの名前>	Azure サブスクリプションを選択します。
Select a storage account (ストレージアカウントを選択する)	新しいストレージアカウントの作成
Enter the name of the new storage account (新しいストレージアカウントの名前を入力する)	<一意の名前>	作成するストレージアカウントの名前
リソースグループの選択	<一意の名前>	作成するリソースグループの名前
場所を選択します。	リージョン	近くのリージョンを選択します

ターミナル パネルで、HTTP によってトリガーされる関数の URL エンドポイントをコピーします。

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

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

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

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

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

{
    "name": "hello_orchestrator",
    "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"
}

デバッグを停止するには、Visual Studio Code で Shift + F5 キーを押します。

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

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

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

既にサインインしていて、既存のサブスクリプションを確認できる場合は、次のセクションに進みます。まだ Azure アカウントがない場合は、[Azure アカウントの作成] を選択します。学生の方は [Microsoft Azure for Students アカウントの作成] を選択してください。
ブラウザーでプロンプトが表示されたら、ご利用の Azure アカウントを選択し、その Azure アカウントの資格情報を使用してサインインします。新しいアカウントを作成した場合は、アカウントの作成後にサインインできます。
正常にサインインしたら、新しいブラウザーウィンドウを閉じてかまいません。ご利用の Azure アカウントに属しているサブスクリプションがサイドバーに表示されます。

Azure に関数アプリを作成する

このセクションでは、Azure サブスクリプションに関数アプリと関連リソースを作成します。

アクティビティバーの Azure アイコンを選択します。次に、[リソース] 領域の + アイコンを選択し、[Azure に関数アプリを作成] オプションを選択します。

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

Prompt	[選択]
サブスクリプションを選択してください	使用するサブスクリプションを選択します。 [リソース] に表示されるサブスクリプションが 1 つだけのときは、このプロンプトは表示されません。
関数アプリのグローバルに一意の名前を入力してください	URL パスに有効な名前を入力します。入力した名前は、Azure Functions 内での一意性を確保するために検証されます。
ランタイムスタックを選択してください	ローカルで実行している言語バージョンを選択してください。
Select a location for new resources (新しいリソースの場所を選択してください)	パフォーマンスを向上させるために、お近くのリージョンを選択してください。

この拡張機能は、Azure に作成されている個々のリソースの状態を [Azure: アクティビティログ] パネルに表示します。

Azure リソース作成のログ

作成が完了すると、次の Azure リソースがサブスクリプションに作成されます。リソースは、関数アプリの名前に基づいて命名されます。
- リソースグループ。関連リソースの論理コンテナーです。
- Standard Azure ストレージアカウント。プロジェクトについての状態とその他の情報を保持します。
- 関数アプリ。関数コードを実行するための環境となります。関数アプリを使用すると、同じホスティングプランに含まれるリソースの管理、デプロイ、共有を容易にするための論理ユニットとして関数をグループ化できます。
- App Service プラン。関数アプリの基になるホストを定義します。
- 関数アプリに接続された Application Insights インスタンス。アプリ内の関数の使用を追跡します。
関数アプリが作成され、展開パッケージが適用されると、通知が表示されます。

ヒント

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

Azure にプロジェクトをデプロイする

重要

既存の関数アプリにデプロイすると、Azure にあるそのアプリの内容が常に上書きされます。

Azure アクティビティの [リソース] 領域で、先ほど作成した関数アプリリソースを見つけて、リソースを右クリックし、[関数アプリにデプロイ] を選択します。
前のデプロイの上書きを求められたら、[デプロイ] を選択して、関数コードを新しい関数アプリリソースにデプロイします。
デプロイの完了後、[View Output] (出力の表示) を選択すると、作成済みの Azure リソースなど、作成とデプロイの結果が表示されます。通知を見逃した場合は、右下隅にあるベルアイコンを選択して、再度確認します。

Azure で関数をテストする

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

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

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

次のステップ

Visual Studio Code を使用して、Python の永続関数アプリを作成して発行しました。

Durable Functions の一般的なパターンについて学習する

Python で最初の永続関数を作成する

前提条件

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

PyPI からの azure-functions-durable のインストール

関数を作成する

オーケストレーター関数

アクティビティ関数

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

必要条件

v2 プログラミング モデルを有効にする

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

Azure へのサインイン

Azure に関数アプリを作成する

Azure にプロジェクトをデプロイする

Azure で関数をテストする

次のステップ

その他のリソース

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

v2 プログラミングモデルを有効にする