ローカルでの Azure Storage の開発に Azurite エミュレーターを使用する

Azurite は Visual Studio 2022 で自動的に使用できるようになります。 Azurite 実行可能ファイルは、Visual Studio の新しいバージョン リリースの一部として更新されます。 以前のバージョンの Visual Studio を実行している場合は、Node パッケージ マネージャー (npm) か DockerHub のいずれかを使用して、または Azurite GitHub リポジトリを複製して、Azurite をインストールできます。

Visual Studio Code で、拡張機能アイコンを選択し、「Azurite」を検索します。 Azurite 拡張機能をインストールするには、[インストール] ボタンを選択します。

また、ブラウザーで Visual Studio Code 拡張機能のマーケットに移動することもできます。 [Install](インストール) を選択して Visual Studio Code を開き、Azurite 拡張機能ページに直接アクセスします。

Azurite 拡張機能の設定を構成する

Visual Studio Code 内で Azurite を構成するには、拡張機能アイコンを選択します。 Azurite エントリの場合は、[管理] 歯車ボタンを選択します。 [拡張機能の設定] を選択します。

次の設定がサポートされています。

• azurite.blobHost - Blob service のリスニング エンドポイント。 既定の設定は 127.0.0.1 です。

• azurite.blobPort - Blob service のリスニング ポート。 既定のポートは 10000 です。

• azurite.queueHost - Queue サービスのリスニング エンドポイント。 既定の設定は 127.0.0.1 です。

• azurite.queuePort - Queue サービスのリスニング ポート。 既定のポートは 10001 です。

• azurite.tableHost - Table service のリッスン エンドポイント (既定の設定は 127.0.0.1)。

• azurite.tablePort - Table service のリッスン エンドポイント (既定では 10002)

• azurite.cert - HTTPS モードを有効にするための、ローカルに信頼されている PEM または PFX 証明書ファイルへのパス。

• azurite.debug - Azurite チャネルにデバッグ ログを出力します。 既定値は false です。

• azurite.key - ローカルに信頼されている PEM キー ファイルへのパス。Azurite: Cert が PEM ファイルを指す場合は必須です。

• azurite.location - ワークスペースの場所のパス。 既定値は Visual Studio Code の作業フォルダーです。

• azurite.loose - ルーズ モード (サポートされていないヘッダーとパラメーターを無視します) を有効にします。

• azurite.oauth - 省略可能な OAuth レベル。

• azurite.pwd - PFX ファイルのパスワード。 Azurite:Cert が PFX ファイルを指す場合は必須です。

• azurite.silent - サイレント モードではアクセス ログが無効になります。 既定値は false です。

• azurite.skipApiVersionCheck - 要求 API バージョン チェックをスキップします。 既定値は false です。

• azurite.disableProductStyleUrl 要求 URI ホストからではなく、要求 URI パスからストレージ アカウント名の解析を強制します。

このインストール方法では、Node.js バージョン8.0 以降がインストールされている必要があります。 ノード パッケージ マネージャー (npm) は、Node.js のすべてのインストールに含まれるパッケージ管理ツールです。 Node.js をインストールした後、次の npm コマンドを実行して Azurite をインストールします。

npm install -g azurite

DockerHub を使用して、次のコマンドを使用することによって最新の Azurite イメージをプルします。

docker pull mcr.microsoft.com/azure-storage/azurite

このインストール方法では、Git と Node.js バージョン8.0 以降をインストールしておく必要があります。 次のコンソール コマンドを使用して、Azurite プロジェクト用の GitHub リポジトリを複製します。

git clone https://github.com/Azure/Azurite.git

ソースコードを複製した後、複製されたリポジトリのルートから次のコマンドを実行して、Azurite をビルドおよびインストールします。

npm install
npm run build
npm install -g

Visual Studio のほとんどのプロジェクト タイプで Azurite を使用するには、まず Azurite 実行可能ファイルを実行する必要があります。 実行可能ファイルが実行されると、Azurite はアプリケーションからの接続要求をリッスンします。 詳細については、「コマンド ラインからの Azurite の実行」を参照してください。

Azure Functions プロジェクトと ASP.NET プロジェクトでは、Azurite を自動的に開始するようにプロジェクトを構成するよう選択できます。 この構成は、プロジェクトのセットアップ中に行われます。 このプロジェクト構成では Azurite が自動的に開始されますが、Visual Studio では詳細な Azurite 構成オプションは公開されません。 Azurite の詳細な構成オプションをカスタマイズするには、Visual Studio を起動する前に Azurite 実行可能ファイルを実行します。

Azurite を自動的に開始するように Azure Functions プロジェクトと ASP.NET プロジェクトを構成する方法の詳細については、次のガイダンスを参照してください。

• Azure Functions プロジェクトからの Azurite の実行
• ASP.NET プロジェクトからの Azurite の実行

Azurite 実行可能ファイルの場所

次の表は、Windows コンピューターで実行されている Visual Studio のさまざまなバージョンの Azurite 実行可能ファイルの場所を示しています。

コマンド ラインからの Azurite の実行

Azurite 実行可能ファイルの場所の表で詳しく説明されているように、Azurite 実行可能ファイルは Visual Studio インストールの extensions フォルダーにあります。

適切な場所に移動して azurite.exe を開始します。 実行可能ファイルを実行すると、Azurite は接続をリッスンします。

Azurite を構成するために使用できるコマンド ライン オプションの詳細については、「コマンド ライン オプション」を参照してください。

Azure Functions プロジェクトからの Azurite の実行

Visual Studio 2022 で、Azure Functions プロジェクトを作成します。 プロジェクト オプションを設定するときに、[ランタイム ストレージ アカウントに Azurite を使用する] というラベルの付いたボックスにマークを付けます。

プロジェクトを作成すると、Azurite が自動的に開始されます。 Azurite 実行可能ファイルの場所については、Azurite 実行可能ファイルの場所の表を参照してください。 出力は次のスクリーンショットのようになります。

この構成オプションは、プロジェクトの接続済みサービスの依存関係を変更して後で変更することができます。

ASP.NET プロジェクトからの Azurite の実行

Visual Studio 2022 で、ASP.NET Core Web アプリ プロジェクトを作成します。 [接続済みサービス] ダイアログ ボックスを開き、[サービス依存関係の追加] を選択し、[ストレージ Azurite エミュレーター] を選択します。

[Configure Storage Azurite emulator](ストレージ Azurite エミュレーターの構成) ダイアログ ボックスで、[接続文字列名] フィールドを StorageConnectionString に設定し、[完了] を選択します。

構成が完了したら、[閉じる] を選択すると、Azurite エミュレーターが自動的に起動します。 Azurite 実行可能ファイルの場所については、Azurite 実行可能ファイルの場所の表を参照してください。 出力は次のスクリーンショットのようになります。

この構成オプションは、プロジェクトの接続済みサービスの依存関係を変更して後で変更することができます。

Azurite 拡張機能は、次の Visual Studio Code コマンドをサポートしています。 コマンド パレットを開くには、Visual Studio Code で F1 を押します。

• Azurite:Clean - すべての Azurite サービス永続性データをリセットします
• Azurite:Clean Blob Service - Blob Service をクリーンアップします
• Azurite:Clean Queue Service - Queue service をクリーンアップします
• Azurite: Clean Table Service - Table service をクリーンアップします
• Azurite:Close - すべての Azurite サービスを閉じます
• Azurite:Close Blob Service - Blob Service を閉じます
• Azurite:Close Queue Service - Queue service を閉じます
• Azurite: Close Table Service - Table service を閉じます
• Azurite:Start - すべての Azurite サービスを開始します
• Azurite:Start Blob Service - Blob Service を開始します
• Azurite:Start Queue Service - Queue service を開始します
• Azurite: Start Table Service - Table service を開始します

次のコマンドを発行して、Azurite を起動します。

azurite --silent --location c:\azurite --debug c:\azurite\debug.log

このコマンドは、すべてのデータを特定のディレクトリ c:\azurite に格納するように Azurite に指示します。 --location オプションを省略した場合は、現在の作業ディレクトリが使用されます。

Azurite Docker イメージを実行する:

次のコマンドは Azurite Docker を実行します。 -p 10000:10000 パラメーターにより、ホスト マシンのポート 10000 から Docker インスタンスに要求がリダイレクトされます。

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 \
    mcr.microsoft.com/azure-storage/azurite

ワークスペースの場所を指定する:

次の例で、-v c:/azurite:/data パラメーターでは Azurite の永続的なデータの場所として c:/azurite が指定されています。 Docker コマンドを実行する前に、c:/azurite ディレクトリを作成しておく必要があります。

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 \
    -v c:/azurite:/data mcr.microsoft.com/azure-storage/azurite

Blob Service だけを実行する

docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite \
    azurite-blob --blobHost 0.0.0.0 --blobPort 10000

起動時に Azurite を構成する方法の詳細については、「コマンド ライン オプション」を参照してください。

コマンド ラインを使用してすぐに作業を開始するには、c:\azurite という名前のディレクトリを作成し、次のコマンドを発行して Azurite を起動します。

azurite --silent --location c:\azurite --debug c:\azurite\debug.log

このコマンドは、すべてのデータを特定のディレクトリ c:\azurite に格納するように Azurite に指示します。 --location オプションを省略した場合は、現在の作業ディレクトリが使用されます。

オプション - 既定では、Azurite はローカル サーバーとして 127.0.0.1 をリッスンします。 要件に合わせてアドレスを設定するには、--blobHost スイッチを使用します。

ローカル コンピューターの要求のみを受け入れる:

azurite --blobHost 127.0.0.1

リモート要求を許可する:

azurite --blobHost 0.0.0.0

オプション - 既定では、Azurite はローカル サーバーとして 127.0.0.1 をリッスンします。 要件に合わせてアドレスを設定するには、--queueHost スイッチを使用します。

ローカル コンピューターの要求のみを受け入れる:

azurite --queueHost 127.0.0.1

リモート要求を許可する:

azurite --queueHost 0.0.0.0

オプション - 既定では、Azurite はローカル サーバーとして 127.0.0.1 をリッスンします。 要件に合わせてアドレスを設定するには、--tableHost スイッチを使用します。

ローカル コンピューターの要求のみを受け入れる:

azurite --tableHost 127.0.0.1

リモート要求を許可する:

azurite --tableHost 0.0.0.0

オプション - 既定では、Azurite は Blob service をポート 10000 でリッスンします。 必要なリスニング ポートを指定するには、--blobPort スイッチを使用します。

Blob service のリスニング ポートをカスタマイズする:

azurite --blobPort 8888

使用可能なポートをシステムに自動選択させる:

azurite --blobPort 0

使用中のポートは Azurite の起動時に表示されます。

オプション - 既定では、Azurite は Queue サービスをポート 10001 でリッスンします。 必要なリスニング ポートを指定するには、--queuePort スイッチを使用します。

Queue サービスのリスニング ポートをカスタマイズします。

azurite --queuePort 8888

使用可能なポートをシステムに自動選択させる:

azurite --queuePort 0

使用中のポートは Azurite の起動時に表示されます。

オプション - 既定では、Azurite は Table サービスをポート 10002 でリッスンします。 必要なリスニング ポートを指定するには、--tablePort スイッチを使用します。

Table service のリスニング ポートをカスタマイズします。

azurite --tablePort 11111

使用可能なポートをシステムに自動選択させる:

azurite --tablePort 0

使用中のポートは Azurite の起動時に表示されます。

Blob Storage にのみ接続する場合、接続文字列は次のようになります。

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;

Queue Storage にのみ接続する場合、接続文字列は次のようになります。

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;

Table Storage にのみ接続する場合、接続文字列は次のようになります。

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=http://127.0.0.1:10002/devstoreaccount1;

Blob service のみを使用する場合、HTTPS 接続文字列は次のようになります。

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;

Queue サービスのみを使用する場合、HTTPS 接続文字列は次のようになります。

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;

テーブル サービスのみを使用する場合、HTTPS 接続文字列は次のようになります。

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;

Blob Storage リソースを操作するには、BlobContainerClient、BlobServiceClient、または BlobClient のインスタンスを作成します。

次の例は、DefaultAzureCredential、接続文字列、共有キーの 3 つの異なる承認メカニズムを使用して BlobContainerClient オブジェクトを承認する方法を示しています。 DefaultAzureCredential はベアラー トークンベースの認証メカニズムを提供し、認証に使用される資格情報の種類のチェーンを使用します。 認証されると、この資格情報はクライアントのインスタンス化の一部として OAuth トークンを提供します。 詳細については、「DefaultAzureCredential クラス」のリファレンスを参照してください。

// With container URL and DefaultAzureCredential
var client = new BlobContainerClient(
    new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new BlobContainerClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;", "container-name"
  );

// With account name and key
var client = new BlobContainerClient(
    new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );

Queue Storage リソースを操作するには、QueueClient または QueueServiceClient のインスタンスを作成します。

次の例は、DefaultAzureCredential、接続文字列、共有キーの 3 つの異なる承認メカニズムを使用して QueueClient オブジェクトを作成し承認する方法を示しています。 DefaultAzureCredential はベアラー トークンベースの認証メカニズムを提供し、認証に使用される資格情報の種類のチェーンを使用します。 認証されると、この資格情報はクライアントのインスタンス化の一部として OAuth トークンを提供します。 詳細については、「DefaultAzureCredential クラス」のリファレンスを参照してください。

// With queue URL and DefaultAzureCredential
var client = new QueueClient(
    new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new QueueClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;", "queue-name"
  );

// With account name and key
var client = new QueueClient(
    new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );

Table Storage リソースを操作するには、TableClient または TableServiceClient のインスタンスを作成します。

次の例は、DefaultAzureCredential、接続文字列、共有キーの 3 つの異なる承認メカニズムを使用して TableClient オブジェクトを作成し承認する方法を示しています。 DefaultAzureCredential はベアラー トークンベースの認証メカニズムを提供し、認証に使用される資格情報の種類のチェーンを使用します。 認証されると、この資格情報はクライアントのインスタンス化の一部として OAuth トークンを提供します。 詳細については、「DefaultAzureCredential クラス」のリファレンスを参照してください。

// With table URL and DefaultAzureCredential
var client = new Client(
    new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new TableClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;", "table-name"
  );

// With account name and key
var client = new TableClient(
    new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );