Azure Functions における Azure Blob Storage の入力バインド
入力バインドを使用すると、Azure 関数への入力として BLOB Storage データを読み取ることができます。
セットアップと構成の詳細については、概要に関する記事を参照してください。
重要
この記事では、タブを使用して、Node.js プログラミング モデルの複数のバージョンに対応しています。 v4 モデルは一般提供されており、JavaScript と TypeScript の開発者にとって、より柔軟で直感的なエクスペリエンスが得られるように設計されています。 v4 モデルの動作の詳細については、Azure Functions Node.js 開発者ガイドを参照してください。 v3 と v4 の違いの詳細については、移行ガイドを参照してください。
Azure Functions では、Python の 2 つのプログラミング モデルがサポートされています。 バインドを定義する方法は、選択したプログラミング モデルによって異なります。
Python v2 プログラミング モデルでは、Python 関数コードでデコレーターを使用してバインドを直接定義できます。 詳細については、「Python 開発者ガイド」を参照してください。
この記事は、両方のプログラミング モデルをサポートしています。
例
A C# 関数は、次の C# モードのいずれかを使用して作成できます。
- 分離されたワーカー モデル: ランタイムから分離されたワーカー プロセスで実行されるコンパイル済みの C# 関数。 分離ワーカー プロセスは、LTS および 非 LTS バージョンの .NET および .NET Framework で実行されている C# 関数をサポートするために必要です。 分離ワーカー プロセス関数の拡張機能では、
Microsoft.Azure.Functions.Worker.Extensions.*
名前空間が使用されます。 - インプロセス モデル: Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数。 このモデルの一部では、主に C# ポータルの編集のためにサポートされている C# スクリプトを使用して Functions を実行できます。 インプロセス関数の拡張機能では、
Microsoft.Azure.WebJobs.Extensions.*
名前空間が使用されます。
重要
インプロセス モデルのサポートは 2026 年 11 月 10 日に終了します。 完全なサポートのために、分離ワーカー モデルにアプリを移行することを強くお勧めします。
次の例は C# 関数であり、分離ワーカー プロセスで実行され、BLOB 入力と BLOB 出力の両方の BLOB バインドを持つ BLOB トリガーを使用します。 この関数は、test-sample-trigger コンテナーの BLOB の作成によってトリガーされます。 test-samples-input コンテナーからテキスト ファイルを読み取り、トリガーされたファイルの名前に基づいて、出力コンテナーに新しいテキスト ファイルを作成します。
public static class BlobFunction
{
[Function(nameof(BlobFunction))]
[BlobOutput("test-samples-output/{name}-output.txt")]
public static string Run(
[BlobTrigger("test-samples-trigger/{name}")] string myTriggerItem,
[BlobInput("test-samples-input/sample1.txt")] string myBlob,
FunctionContext context)
{
var logger = context.GetLogger("BlobFunction");
logger.LogInformation("Triggered Item = {myTriggerItem}", myTriggerItem);
logger.LogInformation("Input Item = {myBlob}", myBlob);
// Blob Output
return "blob-output content";
}
}
}
このセクションには、次の例が含まれています。
HTTP トリガー、クエリ文字列から BLOB を検索する
次の例では、Java 関数が HttpTrigger
注釈を利用し、BLOB ストレージ コンテナーのファイル名を含むパラメーターを受け取ります。 BlobInput
注釈によってファイルが読み取られ、その内容が byte[]
として関数に渡されます。
@FunctionName("getBlobSizeHttp")
@StorageAccount("Storage_Account_Connection_String")
public HttpResponseMessage blobSize(
@HttpTrigger(name = "req",
methods = {HttpMethod.GET},
authLevel = AuthorizationLevel.ANONYMOUS)
HttpRequestMessage<Optional<String>> request,
@BlobInput(
name = "file",
dataType = "binary",
path = "samples-workitems/{Query.file}")
byte[] content,
final ExecutionContext context) {
// build HTTP response with size of requested blob
return request.createResponseBuilder(HttpStatus.OK)
.body("The size of \"" + request.getQueryParameters().get("file") + "\" is: " + content.length + " bytes")
.build();
}
キュー トリガー、キュー メッセージから BLOB 名前を受け取る
次の例では、Java 関数が QueueTrigger
注釈を利用し、BLOB ストレージ コンテナーのファイル名を含むメッセージを受け取ります。 BlobInput
注釈によってファイルが読み取られ、その内容が byte[]
として関数に渡されます。
@FunctionName("getBlobSize")
@StorageAccount("Storage_Account_Connection_String")
public void blobSize(
@QueueTrigger(
name = "filename",
queueName = "myqueue-items-sample")
String filename,
@BlobInput(
name = "file",
dataType = "binary",
path = "samples-workitems/{queueTrigger}")
byte[] content,
final ExecutionContext context) {
context.getLogger().info("The size of \"" + filename + "\" is: " + content.length + " bytes");
}
Java 関数ランタイム ライブラリで、その値が BLOB に由来するパラメーター上で @BlobInput
注釈を使用します。 この注釈は、Java のネイティブ型、POJO、または Optional<T>
を使用した null 許容値で使用できます。
キューによってトリガーされ、BLOB のコピーを作成する TypeScript 関数を次の例に示します。 関数は、コピーする BLOB の名前を含むキュー メッセージによってトリガーされます。 新しい BLOB の名前は {originalblobname}-Copy です。
import { app, input, InvocationContext, output } from '@azure/functions';
const blobInput = input.storageBlob({
path: 'samples-workitems/{queueTrigger}',
connection: 'MyStorageConnectionAppSetting',
});
const blobOutput = output.storageBlob({
path: 'samples-workitems/{queueTrigger}-Copy',
connection: 'MyStorageConnectionAppSetting',
});
export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<unknown> {
return context.extraInputs.get(blobInput);
}
app.storageQueue('storageQueueTrigger1', {
queueName: 'myqueue-items',
connection: 'MyStorageConnectionAppSetting',
extraInputs: [blobInput],
return: blobOutput,
handler: storageQueueTrigger1,
});
キューによってトリガーされ、BLOB のコピーを作成する JavaScript 関数を次の例に示します。 関数は、コピーする BLOB の名前を含むキュー メッセージによってトリガーされます。 新しい BLOB の名前は {originalblobname}-Copy です。
const { app, input, output } = require('@azure/functions');
const blobInput = input.storageBlob({
path: 'samples-workitems/{queueTrigger}',
connection: 'MyStorageConnectionAppSetting',
});
const blobOutput = output.storageBlob({
path: 'samples-workitems/{queueTrigger}-Copy',
connection: 'MyStorageConnectionAppSetting',
});
app.storageQueue('storageQueueTrigger1', {
queueName: 'myqueue-items',
connection: 'MyStorageConnectionAppSetting',
extraInputs: [blobInput],
return: blobOutput,
handler: (queueItem, context) => {
return context.extraInputs.get(blobInput);
},
});
次の例は、function.json ファイルで定義されている BLOB 入力バインドを示しています。このバインドにより、受信 BLOB データを PowerShell 関数で使用できるようになります。
json 構成を次に示します。
{
"bindings": [
{
"name": "InputBlob",
"type": "blobTrigger",
"direction": "in",
"path": "source/{name}",
"connection": "AzureWebJobsStorage"
}
]
}
関数コードを次に示します。
# Input bindings are passed in via param block.
param([byte[]] $InputBlob, $TriggerMetadata)
Write-Host "PowerShell Blob trigger: Name: $($TriggerMetadata.Name) Size: $($InputBlob.Length) bytes"
この例では、SDK 型を使用して、BLOB ストレージ入力バインドによって提供される基になる BlobClient
オブジェクトに直接アクセスします。
import logging
import azure.functions as func
import azurefunctions.extensions.bindings.blob as blob
app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)
@app.route(route="file")
@app.blob_input(
arg_name="client", path="PATH/TO/BLOB", connection="AzureWebJobsStorage"
)
def blob_input(req: func.HttpRequest, client: blob.BlobClient):
logging.info(
f"Python blob input function processed blob \n"
f"Properties: {client.get_blob_properties()}\n"
f"Blob content head: {client.download_blob().read(size=1)}"
)
return "ok"
他の SDK の種類の使用例については、 ContainerClient
と StorageStreamDownloader
のサンプルを参照してください。
プロジェクトで SDK 型バインドを有効にする方法など、詳細については、「 SDK 型バインドを参照してください。
このコードでは、BLOB のコピーを作成します。
import logging
import azure.functions as func
app = func.FunctionApp()
@app.function_name(name="BlobOutput1")
@app.route(route="file")
@app.blob_input(arg_name="inputblob",
path="sample-workitems/test.txt",
connection="<BLOB_CONNECTION_SETTING>")
@app.blob_output(arg_name="outputblob",
path="newblob/test.txt",
connection="<BLOB_CONNECTION_SETTING>")
def main(req: func.HttpRequest, inputblob: str, outputblob: func.Out[str]):
logging.info(f'Python Queue trigger function processed {len(inputblob)} bytes')
outputblob.set(inputblob)
return "ok"
属性
インプロセスと分離ワーカー プロセスの C# ライブラリの両方で、属性を使って関数を定義します。 C# スクリプトでは、C# スクリプト ガイドで説明されているように、代わりに function.json 構成ファイルを使用します。
分離ワーカー プロセスでは、次のパラメーターを受け取る BlobInputAttribute
属性を使用して入力バインディングを定義します。
パラメーター | 説明 |
---|---|
BlobPath | BLOB へのパス。 |
接続 | Azure Blob への接続方法を指定するアプリ設定または設定コレクションの名前。 「接続」を参照してください。 |
ローカルで開発する場合は、Values
コレクション内の local.settings.json ファイルにアプリケーション設定を追加します。
デコレーター
Python v2 プログラミング モデルにのみ適用されます。
デコレーターを使用して定義された Python v2 関数の場合、blob_input
および blob_output
デコレーターの次のプロパティによって Blob Storage トリガーが定義されます。
プロパティ | 説明 |
---|---|
arg_name |
関数コード内の BLOB を表す変数の名前。 |
path |
BLOB へのパス blob_input デコレーターの場合は、読み取られた BLOB です。 blob_output デコレーターの場合は、入力 BLOB の出力またはコピーです。 |
connection |
ストレージ アカウントの接続文字列。 |
data_type |
動的に型指定される言語の場合は、基になるデータ型を指定します。 設定可能な値は、string 、binary 、または stream です。 詳細については、トリガーとバインドの概念に関する記事を参照してください。 |
function.json を使用して定義された Python 関数については、[構成] セクションを参照してください。
注釈
@BlobInput
属性を使用すると、関数をトリガーした BLOB にアクセスできます。 この属性と共にバイト配列を使用する場合は、dataType
を binary
に設定します。 詳細については、「入力 - 例」を参照してください。
構成
"Python v1 プログラミング モデルにのみ適用されます。"
次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。
function.json のプロパティ | 説明 |
---|---|
type | blob に設定する必要があります。 |
direction | in に設定する必要があります。 例外は、使用方法のセクションに記載しています。 |
name | 関数コード内の BLOB を表す変数の名前。 |
path | BLOB へのパス。 |
connection | Azure Blob への接続方法を指定するアプリ設定または設定コレクションの名前。 「接続」を参照してください。 |
dataType | 動的に型指定される言語の場合は、基になるデータ型を指定します。 設定可能な値は、string 、binary 、または stream です。 詳細については、トリガーとバインドの概念に関する記事を参照してください。 |
完全な例については、セクションの例を参照してください。
使用法
BLOB 入力でサポートされるバインドの種類は、拡張機能パッケージのバージョンと、関数アプリで使用される C# モダリティによって異なります。
関数で 1 つの BLOB を処理するとき、BLOB 入力バインドは次の型にバインドできます。
Type | 説明 |
---|---|
string |
BLOB コンテンツを表す文字列。 BLOB コンテンツが単純なテキストのときに使用します。 |
byte[] |
BLOB コンテンツのバイト数。 |
JSON シリアル化可能な型 | BLOB に JSON データが含まれているとき、Functions は JSON データを単純な従来の CLR オブジェクト (POCO) 型に逆シリアル化しようとします。 |
Stream1 | BLOB コンテンツの入力ストリーム。 |
BlobClient1、 BlockBlobClient1、 PageBlobClient1、 AppendBlobClient1、 BlobBaseClient1 |
BLOB に接続されているクライアント。 この型のセットには BLOB の処理に対する最大限の制御機能が備わっています。接続に十分なアクセス許可がある場合は、それへの書き戻しに使用できます。 |
関数で 1 つのコンテナーの複数の BLOB を処理するとき、BLOB 入力バインドは次の型にバインドできます。
Type | 説明 |
---|---|
T[] または List<T> (T は単一の BLOB 入力バインドの型のいずれか) |
複数の BLOB の配列またはリスト。 各エントリは、コンテナーの 1 つの BLOB を表します。 これらの型によって実装される IEnumerable<T> などの任意のインターフェイスにバインドすることもできます。 |
BlobContainerClient1 | コンテナーに接続されているクライアント。 この型にはコンテナーの処理に対する最大限の制御機能が備わっています。接続に十分なアクセス許可がある場合は、それへの書き込みに使用できます。 |
1 これらの型を使用するには、Microsoft.Azure.Functions.Worker.Extensions.Storage.Blobs 6.0.0 以降と SDK 型バインドの一般的な依存関係に関する記事を参照する必要があります。
string
または Byte[]
へのバインドが推奨されるのは、BLOB のサイズが小さい場合のみです。 これが推奨されるのは、BLOB 全体の内容がメモリに読み込まれるためです。 ほとんどの BLOB では、Stream
型または BlobClient
型を使用します。 詳細については、「コンカレンシーとメモリ使用量」を参照してください。
Storage SDK タイプの 1 つにバインドしようとしてエラー メッセージが表示された場合は、適切な Storage SDK バージョンへの参照があることを確認してください。
StorageAccountAttribute を使用して、使用するストレージ アカウントを指定することもできます。 これは、ライブラリ内の他の関数とは異なるストレージ アカウントを使用する必要がある場合に実行できます。 コンストラクターは、ストレージ接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。
[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
[FunctionName("BlobTrigger")]
[StorageAccount("FunctionLevelStorageAppSetting")]
public static void Run( //...
{
....
}
使用するストレージ アカウントは、次の順序で決定されます。
BlobTrigger
属性のConnection
プロパティ。BlobTrigger
属性と同じパラメーターに適用されたStorageAccount
属性。- 関数に適用される
StorageAccount
属性。 - クラスに適用される
StorageAccount
属性。 AzureWebJobsStorage
アプリケーション設定で定義されている、関数アプリの既定のストレージ アカウント。
@BlobInput
属性を使用すると、関数をトリガーした BLOB にアクセスできます。 この属性と共にバイト配列を使用する場合は、dataType
を binary
に設定します。 詳細については、「入力 - 例」を参照してください。
function.json ファイルのバインドの name パラメーターで指定されている名前と一致するパラメーターを使用して、BLOB データにアクセスします。
InputStream に型指定したパラメーターを使用して BLOB データにアクセスします。 詳細については、「入力 - 例」を参照してください。
Functions では、Azure Blob Storage の Python SDK 型バインドもサポートされています。これにより、基になる SDK の種類を使用して BLOB データを操作できます。
重要
Python の SDK の種類のサポートは現在プレビュー段階であり、Python v2 プログラミング モデルでのみサポートされています。 詳細については、Python の SDK 型を参照してください。
つながり
connection
プロパティは、アプリを Azure BLOB に接続する方法を指定する環境構成への参照です。 次が指定される場合があります。
構成された値が、1 つの設定に完全一致し、プレフィックスがその他の設定とも一致する場合は、完全一致が使用されます。
接続文字列
接続文字列を取得するには、「ストレージ アカウント アクセス キーを管理する」の手順に従います。 接続文字列は、BLOB ストレージ アカウントではなく汎用ストレージ アカウントに対するものである必要があります。
この接続文字列は、バインディング構成の connection
プロパティで指定した値と同じ名前のアプリケーション設定に格納する必要があります。
アプリ設定の名前が "AzureWebJobs" で始まる場合は、ここで名前の残りの部分のみを指定できます。 たとえば、connection
を "MyStorage" に設定した場合、Functions ランタイムは "AzureWebJobsMyStorage" という名前のアプリ設定を探します。 connection
を空のままにした場合、Functions ランタイムは、アプリ設定内の AzureWebJobsStorage
という名前の既定のストレージ接続文字列を使用します。
ID ベースの接続
バージョン 5.x 以上の拡張機能を使用している場合 (non-.NET 言語スタックの場合は bundle 3.x 以上)、シークレットで接続文字列を使用する代わりに、アプリで Microsoft Entra ID を使用できます。 ID を使用するには、トリガーとバインドの構成の connection
プロパティにマップされる共通のプレフィックスに設定を定義します。
connection
を "AzureWebJobsStorage" に設定する場合は、「ID を使用してホスト ストレージに接続する」を参照してください。 その他のすべての接続では、拡張機能に次のプロパティが必要です。
プロパティ | 環境変数テンプレート | 説明 | 値の例 |
---|---|---|---|
Blob Service の URI | <CONNECTION_NAME_PREFIX>__serviceUri 1 |
HTTPS スキームを使用して接続している BLOB サービスのデータ プレーン URI。 | https://<storage_account_name>.blob.core.windows.net |
1 <CONNECTION_NAME_PREFIX>__blobServiceUri
はエイリアスとして使用できます。 接続構成が BLOB トリガーによって使用される場合、blobServiceUri
には queueServiceUri
も指定する必要があります。 以下を参照してください。
全体の接続構成が BLOB、キュー、テーブル間で使用される場合、serviceUri
形式は指定できません。 URI では BLOB サービスのみを指定できます。 別の方法として、サービスごとに専用の URI を指定して、1 つの接続を使用できるようにすることができます。 両方のバージョンが指定された場合、マルチサービス形式が使用されます。 複数のサービス用の接続を構成するには、<CONNECTION_NAME_PREFIX>__serviceUri
の代わりに次を設定します。
プロパティ | 環境変数テンプレート | 説明 | 値の例 |
---|---|---|---|
Blob Service の URI | <CONNECTION_NAME_PREFIX>__blobServiceUri |
HTTPS スキームを使用して接続している BLOB サービスのデータ プレーン URI。 | https://<storage_account_name>.blob.core.windows.net |
Queue Service URI (BLOB トリガーに必要2) | <CONNECTION_NAME_PREFIX>__queueServiceUri |
HTTPS スキームを使用したキュー サービスのデータ プレーン URI。 この値は、BLOB トリガーにのみ必要です。 | https://<storage_account_name>.queue.core.windows.net |
2 BLOB トリガーは、複数回にわたる再試行の失敗を、有害な BLOB をキューに書き込むことで処理します。 serviceUri
形式では、AzureWebJobsStorage
接続が使用されます。 ただし、blobServiceUri
を指定する場合は、queueServiceUri
でキュー サービス URI も指定する必要があります。 BLOB サービスと同じストレージ アカウントからサービスを使用することをお勧めします。 また、トリガーでは、ストレージ キュー データ共同作成者のようなロールを割り当てて、構成されたキュー サービスのメッセージを読み書きできるようにする必要があります。
接続をカスタマイズするには、他のプロパティを設定します。 「ID ベース接続に共通のプロパティ」を参照してください。
Azure Functions サービスでホストされている場合、ID ベースの接続では、マネージド ID が使用されます。 ユーザー割り当て ID を credential
および clientID
プロパティで指定できますが、システム割り当て ID が既定で使用されます。 リソース ID を使用したユーザー割り当て ID の構成はサポートされていないことに注意してください。 ローカル開発などの他のコンテキストで実行する場合は、代わりに開発者 ID が使用されますが、カスタマイズすることもできます。 ID ベースの接続によるローカル開発に関するページをご覧ください。
ID にアクセス許可を付与する
使用されている ID が何であれ、目的のアクションを実行するためのアクセス許可が必要です。 ほとんどの Azure では、これはそれらのアクセス許可を提供する組み込みロールまたはカスタム ロールを使って、Azure RBAC でロールを割り当てる必要があることを意味します。
重要
すべてのコンテキストに必要ではない一部のアクセス許可がターゲット サービスによって公開される場合があります。 可能であれば、最小限の特権の原則に従い、必要な特権だけを ID に付与します。 たとえば、アプリがデータ ソースからの読み取りのみを行う必要がある場合は、読み取りアクセス許可のみを持つロールを使用します。 サービスへの書き込みも可能なロールを割り当てることは、読み取り操作に対するアクセス許可が過剰になるため、不適切です。 同様に、ロールの割り当てが、読み取る必要のあるリソースだけに限定されていることを確認する必要があります。
実行時に BLOB コンテナーへのアクセスを提供するロールの割り当てを作成する必要があります。 所有者のような管理ロールでは十分ではありません。 次の表は、通常の操作で Blob Storage の拡張機能を使用するときに推奨される組み込みロールを示しています。 アプリケーションでは、記述したコードに基づいて追加のアクセス許可が必要になる場合があります。
[バインドの種類] | 組み込みロールの例 |
---|---|
トリガー | ストレージ BLOB データ所有者 および ストレージ キュー データ共同作成者1 AzureWebJobsStorage 接続にも追加のアクセス許可を付与する必要があります。2 |
入力バインド | ストレージ BLOB データ閲覧者 |
出力バインド | ストレージ BLOB データ所有者 |
1 BLOB トリガーは、複数回にわたる再試行の失敗を、接続によって指定されたストレージ アカウント上のキューに有害な BLOB を書き込むことにより処理します。
2 AzureWebJobsStorage 接続は、トリガーを有効にする BLOB やキューのために内部的に使用されます。 ID ベースの接続を使用するように構成されている場合は、既定の要件を超える追加のアクセス許可が必要になります。 必要なアクセス許可は、ストレージ BLOB データ所有者、ストレージ キュー データ共同作成者、およびストレージ アカウント共同作成者の各ロールによって満たされます。 詳細については、「ID を使用してホスト ストレージに接続する」を参照してください。