Python アプリAzure Functions開発者向けリファレンス ガイド

作業の開始

ワークフローに合った環境を選択し、PythonのAzure Functionsに移動します。

• Visual Studio Code クイック スタート
• コア ツールのクイック スタート

Python v1 プログラミング モデルでは、各関数は、__init__.py という名前のファイル内のグローバルなステートレス main() メソッドとして定義されます。 関数のトリガーとバインドは、 function.json ファイル内で個別に構成され、バインド name 値が main() メソッドのパラメーターとして使用されます。

例

HTTP 要求に応答する単純な関数を次に示します。

# __init__.py
def main(req):
    user = req.params.get('user')
    return f'Hello, {user}!'

対応する function.json ファイルを次に示します。

{
    "scriptFile": "__init__.py",
    "bindings": [
        {
            "authLevel": "function",
            "type": "httpTrigger",
            "direction": "in",
            "name": "req",
            "methods": [
                "get",
                "post"
            ]
        },
        {
            "type": "http",
            "direction": "out",
            "name": "$return"
        }
    ]
}

重要な概念

• この関数には、1 つの HTTP トリガーがあります。
• HttpRequest オブジェクトには、要求ヘッダー、クエリ パラメーター、ルート パラメーター、およびメッセージ本文が含まれています。 この関数は、name オブジェクトのparams パラメーターからクエリ パラメーターの値を取得します。
• この例で名前を送信するには、公開されている関数の URL に ?name={name} を追加します。 たとえば、ローカルで実行している場合、完全な URL は http://localhost:7071/api/http_trigger?name=Testのようになります。 バインドの使用例については、「 トリガーとバインド」を参照してください。

azure-functions SDK を使用し、IntelliSense とエディターのサポートを向上させるために型の注釈を含めます。

# __init__.py
import azure.functions as func

def http_trigger(req: func.HttpRequest) -> str:

# requirements.txt
azure-functions

azure-functions ライブラリ

azure-functions Python ライブラリには、Azure Functions ランタイムとの対話に使用されるコア型が用意されています。 使用可能なすべての型とメソッドを確認するには、 azure-functions API にアクセスしてください。 関数コードでは、 azure-functions を使用して次のことができます。

• トリガー入力データへのアクセス ( HttpRequest、 TimerRequestなど)
• 出力値の作成 ( HttpResponse など)
• ランタイム提供のコンテキストとバインディング データを操作する

アプリで azure-functions を使用している場合は、プロジェクトの依存関係に含まれている必要があります。

代替エントリ ポイント

scriptFile ファイルでentryPointプロパティとfunction.jsonプロパティを指定することで、関数の既定の動作を変更できます。 たとえば、次の function.json ファイルは、Azure関数のエントリ ポイントとして、main.py ファイルの custom_entry() メソッドを使用するようにランタイムに指示します。

{
  "scriptFile": "main.py",
  "entryPoint": "custom_entry",
  "bindings": [
      ...
  ]
}

フォルダー構造

Python Azure Functions プロジェクトには、次の構造を使用します。

<project_root>/
│
├── .venv/                   # (Optional) Local Python virtual environment
├── .vscode/                 # (Optional) VS Code workspace settings
│
├── my_first_function/       # Function directory
│   └── __init__.py          # Function code file
│   └── function.json        # Function binding configuration file
│
├── my_second_function/
│   └── __init__.py  
│   └── function.json 
│
├── shared/                  # (Optional) Pure helper code with no triggers/bindings
│   └── utils.py
│
├── additional_functions/    # (Optional) Contains blueprints for organizing related Functions
│   └── blueprint_1.py  
│
├── tests/                   # (Optional) Unit tests for your functions
│   └── test_my_function.py
│
├── .funcignore              # Excludes files from being published
├── host.json                # Global function app configuration
├── local.settings.json      # Local-only app settings (not published)
├── requirements.txt         # (Optional) Defines Python dependencies for remote build
├── Dockerfile               # (Optional) For custom container deployment

キー ファイルとフォルダー

Python v2 プログラミング モデルでは、Azure Functionsは decorator ベースのアプローチを使用して、コード内でトリガーとバインドを直接定義します。 各関数は、 ファイル内でfunction_app.pyとして実装されます。

例

HTTP 要求に応答する単純な関数を次に示します。

import azure.functions as func

app = func.FunctionApp()

@app.route("hello")
def http_trigger(req):
    user = req.params.get("user")
    return f"Hello, {user}!"

# requirements.txt
azure-functions

重要な概念

• このコードは、 azure-functions パッケージをインポートし、デコレーターと型を使用して関数アプリを定義します。
• この関数には、1 つの HTTP トリガーがあります。
• HttpRequest オブジェクトには、要求ヘッダー、クエリ パラメーター、ルート パラメーター、およびメッセージ本文が含まれています。 この関数は、name オブジェクトのparams パラメーターからクエリ パラメーターの値を取得します。
• この例で名前を送信するには、公開されている関数の URL に ?name={name} を追加します。 たとえば、ローカルで実行している場合、完全な URL は http://localhost:7071/api/http_trigger?name=Testのようになります。 バインドの使用例については、「 トリガーとバインド」を参照してください。

azure-functions ライブラリ

azure-functions Python ライブラリは、Azure Functions プログラミング モデルの中核となる部分です。 これには、デコレーター、トリガーとバインドの型、および実行時に関数を定義して操作するために使用される要求/応答オブジェクトが用意されています。 使用可能なすべての型とデコレーターを表示するには、 azure-functions API にアクセスしてください。 関数アプリのコードは、次の場合にこのライブラリに依存します。

• FunctionApp オブジェクトを使用してすべての関数を定義する
• トリガーとバインドを宣言する ( @app.route、 @app.timer_triggerなど)
• 型指定された入力と出力にアクセスする ( HttpRequest 、 HttpResponse、Out など)

azure-functionsは、プロジェクトの依存関係に含まれている必要があります。 詳細については、 パッケージ管理に関するページを参照してください。

型注釈を使用して、IntelliSense とエディターのサポートを向上させます。

def http_trigger(req: func.HttpRequest) -> str:

ブループリントを使用した整理

大規模またはモジュール型のアプリの場合は、blueprints を使用して、別のPython ファイルに関数を定義し、メイン アプリに登録します。 この分離により、コードの整理と再利用が維持されます。

ブループリントを定義して登録するには:

1. http_blueprint.py など、別のPython ファイルでブループリントを定義します。

   import azure.functions as func
   
   bp = func.Blueprint()
   
   @bp.route(route="default_template")
   def default_template(req: func.HttpRequest) -> func.HttpResponse:
       return func.HttpResponse("Hello World!")
   

2. ブループリントをメイン function_app.py ファイルに登録します。

   import azure.functions as func
   from http_blueprint import bp
   
   app = func.FunctionApp()
   app.register_functions(bp)
   

ブループリントを使用すると、次のことができます。

• アプリを再利用可能なモジュールに分割する
• 関連する関数をファイルまたは機能別にグループ化する
• プロジェクト間でブループリントを拡張または共有する

フォルダー構造

Python Azure Functions プロジェクトには、次の構造を使用します。

<project_root>/
│
├── .venv/                   # (Optional) Local Python virtual environment
├── .vscode/                 # (Optional) VS Code workspace settings
│
├── function_app.py          # Main function entry point (decorator model)
├── shared/                  # (Optional) Pure helper code with no triggers/bindings
│   └── utils.py
│
├── additional_functions/    # (Optional) Contains blueprints for organizing related Functions
│   └── blueprint_1.py  
│
├── tests/                   # (Optional) Unit tests for your functions
│   └── test_my_function.py
│
├── .funcignore              # Excludes files from being published
├── host.json                # Global function app configuration
├── local.settings.json      # Local-only app settings (not published)
├── requirements.txt         # (Optional) Defines Python dependencies for remote build
├── Dockerfile               # (Optional) For custom container deployment

キー ファイルとフォルダー

例: BLOB 入力を使用したタイマー トリガー

この関数では、次の処理を実行します。

• 10 分ごとにトリガーが実行される
• SDK 型バインドを使用して BLOB から読み取る
• 結果をキャッシュし、一時ファイルに書き込みます

import azure.functions as func
import azurefunctions.extensions.bindings.blob as blob
import logging
import tempfile

CACHED_BLOB_DATA = None

app = func.FunctionApp()

@app.function_name(name="TimerTriggerWithBlob")
@app.schedule(schedule="0 */10 * * * *", arg_name="mytimer")
@app.blob_input(arg_name="client",
                path="PATH/TO/BLOB",
                connection="BLOB_CONNECTION_SETTING")
def timer_trigger_with_blob(mytimer: func.TimerRequest,
                            client: blob.BlobClient,
                            context: func.Context) -> None:
    global CACHED_BLOB_DATA
    if CACHED_BLOB_DATA is None:
        # Download blob and save as a global variable
        CACHED_BLOB_DATA = client.download_blob().readall()

        # Create temp file prefix
        my_prefix = context.invocation_id
        temp_file = tempfile.NamedTemporaryFile(prefix=my_prefix)
        temp_file.write(CACHED_BLOB_DATA)
        logging.info(f"Cached data written to {temp_file.name}")

重要な概念

• SDK の型バインドを使用して、豊富な型を操作します。 詳細については、「 SDK の型バインド」を参照してください。
• グローバル変数を使用してコストの高い計算をキャッシュできますが、その状態が関数の実行間で保持されるとは限りません。
• 一時ファイルは tmp/ に格納され、呼び出しやスケールアウト インスタンス間で保持される保証はありません。
• Context クラスを使用して、関数の呼び出しコンテキストにアクセスできます。

# __init__.py
import azure.functions as func

def main(req: func.HttpRequest,
         documents: func.DocumentList,
         event: func.Out[str]) -> func.HttpResponse:

    # Content from HttpRequest and Cosmos DB input
    http_content = req.params.get("body")
    doc_id = documents[0]["id"] if documents else "No documents found"

    event.set(f"HttpRequest content: {http_content} | CosmosDB ID: {doc_id}")

    return func.HttpResponse(
        "Function executed successfully.",
        status_code=200
    )

// function.json
{
  "scriptFile": "__init__.py",
  "entryPoint": "main",
  "bindings": [
    {
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"],
      "route": "file"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "cosmosDB",
      "direction": "in",
      "name": "documents",
      "databaseName": "test",
      "containerName": "items",
      "id": "cosmosdb-input-test",
      "connection": "COSMOSDB_CONNECTION_SETTING"
    },
    {
      "type": "eventHub",
      "direction": "out",
      "name": "event",
      "eventHubName": "my-test-eventhub",
      "connection": "EVENTHUB_CONNECTION_SETTING"
    }
  ]
}

主な概念

• 各関数には 1 つのトリガーがありますが、複数のバインドを持つことができます。
• directionでfunction.jsonを "in" として指定して入力を追加します。 出力には direction の out があります。
• HttpRequest オブジェクトから要求の詳細にアクセスし、ヘッダー、状態コード、本文を含むカスタム HttpResponseを構築できます。

import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpTriggerWithCosmosDB")
@app.route(route="file")
@app.cosmos_db_input(arg_name="documents",
                     database_name="test",
                     container_name="items",
                     connection="COSMOSDB_CONNECTION_SETTING")
@app.event_hub_output(arg_name="event",
                      event_hub_name="my-test-eventhub",
                      connection="EVENTHUB_CONNECTION_SETTING")
def http_trigger_with_cosmosdb(req: func.HttpRequest,
                               documents: func.DocumentList,
                               event: func.Out[str]) -> func.HttpResponse:
    # Content from HttpRequest and Cosmos DB input
    http_content = req.params.get('body')
    doc_id = documents[0]['id']

    event.set("HttpRequest content: " + http_content
              + " | CosmosDB ID: " + doc_id)

    return func.HttpResponse(
        f"Function executed successfully.",
        status_code=200
    )

重要な概念

• @route()またはトリガー固有のデコレーター (@timer_trigger、@queue_triggerなど) を使用して、関数の呼び出し方法を定義します。
• @blob_input、@queue_inputなどのデコレーターを使用して入力を追加します。
• 出力は次のようになります。
  • 直接返されます (出力が 1 つだけの場合)
  • 複数の出力に対して Out バインドと .set() メソッドを使用して割り当てられます。
• HttpRequest オブジェクトから要求の詳細にアクセスし、ヘッダー、状態コード、本文を含むカスタム HttpResponseを構築できます。

SDK 型のバインド

選択トリガーとバインドでは、基になるAzure SDKsとフレームワークによって実装されたデータ型を操作できます。 これらの SDK 型バインドを使用すると、基になるサービス SDK を使用しているかのようにバインディング データを操作できます。 詳細については、 サポートされている SDK の種類のバインドに関する説明を参照してください。

import azure.functions as func
import requests

def main(req: func.HttpRequest) -> func.HttpResponse:
    r = requests.get("https://api.github.com")
    return func.HttpResponse(f"Status: {r.status_code}")

import azure.functions as func
import requests

app = func.FunctionApp()

@app.function_name(name="HttpExample")
@app.route(route="call_api")
def main(req: func.HttpRequest) -> func.HttpResponse:
    r = requests.get("https://api.github.com")
    return func.HttpResponse(f"Status: {r.status_code}")

# function_app.py
import azure.functions as func

app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)

@app.route(route="http_trigger")
def http_trigger(req: func.HttpRequest) -> func.HttpResponse:
    return "Hello, World!"

# Test the function directly
print(http_trigger(None))

出力を表示するには、Pythonを使用してファイルを直接実行します。

> python function_app.py

Hello, World!

# __init__.py
import azure.functions as func

def main(req: func.HttpRequest) -> func.HttpResponse:
    return func.HttpResponse("Hello, World!")

# Test the function directly
print(main(None))

出力を表示するには、Pythonを使用してファイルを直接実行します。

> python __init__.py

Hello, World!

• ランタイム バージョン管理: requirements.txt で azure-functions-runtime パッケージを参照することで、必要に応じてアプリを特定のPython worker バージョンにピン留めまたはアップグレードできるようになりました。

  • バージョン管理が有効になっていない場合、アプリは、Functions が管理する既定のバージョンの Python ランタイムで実行されます。 requirements.txt ファイルを変更して、最新リリースバージョン、リリース済みバージョンを要求するか、アプリを特定のバージョンのPython ランタイムにピン留めする必要があります。

  • ランタイム バージョン管理を有効にするには、Python ランタイム パッケージへの参照を requirements.txt ファイルに追加します。ここで、パッケージに割り当てられた値によって使用されるランタイム バージョンが決まります。

  • 運用アプリをプレリリース (アルファ、ベータ、または開発) ランタイム バージョンにピン留めしないでください。

  • 変更に注意するには、Python ランタイムリリース ノート定期的に確認してください。

  • 次の表は、 requirements.txt ファイルのこの設定のバージョン値に基づくバージョン管理の動作を示しています。

    Version	例	行動
    値が設定されていません	azure-functions-runtime	Python 3.13 以降のアプリは、使用可能な最新バージョンの Functions Python ランタイムで実行されます。 このオプションは、アプリが自動的に最新の安定したランタイム更新プログラムを受け取るので、プラットフォームの機能強化と機能を最新の状態に保つのに最適です。
    特定のバージョンに固定する	azure-functions-runtime==1.2.0	Python 3.13 以降のアプリは固定されたランタイム バージョンのままであり、自動更新は受け取りません。 代わりに、ランタイムの新機能、修正、および機能強化を利用するために、ピン留めされたバージョンを手動で更新する必要があります。 ピン留めは、安定性と予測可能性が不可欠な重要な運用ワークロードに推奨されます。 ピン留めすると、開発中にリリース前のランタイム バージョンでアプリをテストすることもできます。
    パッケージ参照なし	n/a	azure-functions-runtimeを設定しないと、Python 3.13 以降のアプリは、最新リリースバージョンの背後にあるPython ランタイムの既定のバージョンで実行されます。 更新は、Functions によって定期的に行われます。 このオプションにより、安定性と広範な互換性が保証されます。 ただし、最新の機能と修正プログラムへのアクセスは、既定のバージョンが更新されるまで遅れます。

• 依存関係の分離: アプリの依存関係 ( grpcio や protobufなど) はワーカーの依存関係から完全に分離され、バージョンの競合を防ぎます。 アプリ設定 PYTHON_ISOLATE_WORKER_DEPENDENCIES は、Python 3.13 以降で実行されているアプリには影響しません。

• HTTP ストリーミングのセットアップが簡略化され、特別なアプリ設定は必要ありません。

• ワーカー拡張機能と共有メモリ機能のサポートが削除されました。

• ランタイム バージョン管理: requirements.txt で azure-functions-runtime-v1 パッケージを参照することで、必要に応じてアプリを特定のPython worker バージョンにピン留めまたはアップグレードできるようになりました。

  • バージョン管理が有効になっていない場合、アプリは、Functions が管理する既定のバージョンの Python ランタイムで実行されます。 requirements.txt ファイルを変更して、最新リリースバージョン、リリース済みバージョンを要求するか、アプリを特定のバージョンのPython ランタイムにピン留めする必要があります。

  • ランタイム バージョン管理を有効にするには、Python ランタイム パッケージへの参照を requirements.txt ファイルに追加します。ここで、パッケージに割り当てられた値によって使用されるランタイム バージョンが決まります。

  • 運用アプリをプレリリース (アルファ、ベータ、または開発) ランタイム バージョンにピン留めしないでください。

  • 変更に注意するには、Python ランタイムリリース ノート定期的に確認してください。

  • 次の表は、 requirements.txt ファイルのこの設定のバージョン値に基づくバージョン管理の動作を示しています。

    Version	例	行動
    値が設定されていません	azure-functions-runtime-v1	Python 3.13 以降のアプリは、使用可能な最新バージョンの Functions Python ランタイムで実行されます。 このオプションは、アプリが自動的に最新の安定したランタイム更新プログラムを受け取るので、プラットフォームの機能強化と機能を最新の状態に保つのに最適です。
    特定のバージョンに固定する	azure-functions-runtime-v1==1.2.0	Python 3.13 以降のアプリは固定されたランタイム バージョンのままであり、自動更新は受け取りません。 代わりに、ランタイムの新機能、修正、および機能強化を利用するために、ピン留めされたバージョンを手動で更新する必要があります。 ピン留めは、安定性と予測可能性が不可欠な重要な運用ワークロードに推奨されます。 ピン留めすると、開発中にリリース前のランタイム バージョンでアプリをテストすることもできます。
    パッケージ参照なし	n/a	azure-functions-runtime-v1を設定しないと、Python 3.13 以降のアプリは、最新リリースバージョンの背後にあるPython ランタイムの既定のバージョンで実行されます。 更新は、Functions によって定期的に行われます。 このオプションにより、安定性と広範な互換性が保証されます。 ただし、最新の機能と修正プログラムへのアクセスは、既定のバージョンが更新されるまで遅れます。

• 依存関係の分離: アプリの依存関係 ( grpcio や protobufなど) はワーカーの依存関係から完全に分離され、バージョンの競合を防ぎます。 アプリ設定 PYTHON_ISOLATE_WORKER_DEPENDENCIES は、Python 3.13 以降で実行されているアプリには影響しません。

• ワーカー拡張機能と共有メモリ機能のサポートが削除されました。

import logging
import azure.functions as func

def main(req: func.HttpRequest) -> func.HttpResponse:
    logging.debug("Example debug log")
    logging.info("Example info log")
    logging.warning("Example warning")
    logging.error("Example error log")
    return func.HttpResponse("OK")

import logging
import azure.functions as func

app = func.FunctionApp()

@app.route(route="http_trigger")
def http_trigger(req) -> func.HttpResponse:
    logging.debug("Example debug log")
    logging.info("Example info log")
    logging.warning("Example warning")
    logging.error("Example error log")
    return func.HttpResponse("OK")

import logging
import threading
import azure.functions as func

def main(req: func.HttpRequest, context) -> func.HttpResponse:
    logging.info("Function started")
    t = threading.Thread(target=log_from_thread, args=(context,))
    t.start()
    return "okay"

def log_from_thread(context):
    # Associate the thread with the current invocation
    context.thread_local_storage.invocation_id = context.invocation_id  
    logging.info("Logging from a background thread")

import azure.functions as func
import logging
import threading

app = func.FunctionApp()

@app.route(route="http_trigger")
def http_trigger(req, context) -> func.HttpResponse:
    logging.info("Function started")
    t = threading.Thread(target=log_from_thread, args=(context,))
    t.start()
    return "okay"

def log_from_thread(context):
    # Associate the thread with the current invocation
    context.thread_local_storage.invocation_id = context.invocation_id  
    logging.info("Logging from a background thread")