クイックスタート: .NET Core で Azure Redis を使用する

このクイック スタートでは、Azure 内の任意のアプリケーションからアクセスできるセキュリティで保護された専用キャッシュにアクセスするために、Azure Cache for Redis を .NET Core アプリに組み込みます。 具体的には、.NET Core コンソール アプリで StackExchange.Redis クライアントと C# コードを使用します。

GitHub のコードにスキップする

GitHub でリポジトリ https://github.com/Azure-Samples/azure-cache-redis-samples/tree/main/quickstart/dotnet-core をクローンします。

前提条件

• Azure サブスクリプション - 無料アカウントを作成する
• .NET Core SDK

Azure Managed Redis (プレビュー) インスタンスを作成する

1. Azure Managed Redis (プレビュー) インスタンスを作成するには、Azure portal にサインインし、[リソースの作成] を選択します。

2. [新規] ページで、検索ボックスに「Azure Cache for Redis」と入力します。

3. [新規 Redis Cache] ページで、新しいキャッシュの設定を構成します。

   設定	値を選択する	説明
   サブスクリプション	ドロップダウンで、ご自身のサブスクリプションを選択します。	この新しい Azure Managed Redis インスタンスが作成されるサブスクリプション。
   リソース グループ	ドロップ ダウンでリソース グループを選択するか、 [新規作成] を選択し、新しいリソース グループの名前を入力します。	その中にキャッシュやその他のリソースを作成するリソース グループの名前。 すべてのアプリ リソースを 1 つのリソース グループに配置することで、それらをまとめて簡単に管理または削除できます。
   DNS 名	リージョンで一意の名前を入力します。	キャッシュ名は、"キャッシュのリージョン名と組み合わせた" ときに 1 から 63 文字の文字列で、数字、英字、ハイフンのみを使用する必要があります。 (キャッシュ名の長さが 45 文字未満の場合、現在使用できるすべてのリージョンで機能するはずです)。名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。 キャッシュ インスタンスの "ホスト名" は \<DNS name\>.\<Azure region\>.redis.azure.net です。
   場所	ドロップ ダウンで場所を選択します。	Azure Managed Redis は、選択した Azure リージョンで使用できます。
   キャッシュの種類	ドロップダウン メニューから、パフォーマンス レベルとキャッシュ サイズを選択します。	Redis インスタンスのパフォーマンスはレベルによって決まり、データの格納に使用できるメモリはキャッシュ サイズによって決まります。 適切なパフォーマンス レベルの選択に関するガイダンスについては、「最適なサービス レベルを選択する」を参照してください

   

4. [次へ: ネットワーク] を選択し、パブリックまたはプライベート エンドポイントのいずれかを選択します。

5. [次: 詳細] を選択します。

   インスタンスに追加する Redis モジュールを構成します。

   新しいマネージド キャッシュの場合、既定で次のように設定されています:

   • Microsoft Entra ID は有効になっています。
   • [アクセス キー認証] は、セキュリティ上の理由から無効になっています。

   重要

   最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセス キーの認可より、セキュリティと使いやすさの点で優れています。 キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証への Microsoft Entra ID の使用に関する記事をご覧ください。

   クラスター化されていないキャッシュの [Clustering policy] (クラスタリング ポリシー) を [Enterprise] に設定するか、クラスター化されたキャッシュの場合は [OSS] に設定します。 [クラスタリング ポリシー] の選択方法の詳細については、「クラスタリング ポリシー」を参照してください。

   

   アクティブ geo レプリケーションを使用する場合は、作成時にそれを構成する必要があります。 詳細については、「Azure Managed Redis インスタンスのアクティブ geo レプリケーションを構成する」を参照してください。

   重要

   Azure Managed Redis (プレビュー) インスタンスのクラスタリング ポリシーは、作成後に変更することはできません。 RediSearch を使用している場合、Enterprise クラスター ポリシーは必須であり、サポートされている唯一の削除ポリシーは NoEviction です。

   重要

   geo レプリケーション グループでこのキャッシュ インスタンスを使用している場合、インスタンスの作成後に削除ポリシーを変更することはできません。 キャッシュを作成する前に、プライマリ ノードの削除ポリシーを確認してください。 アクティブ geo レプリケーションの詳細については、「アクティブ geo レプリケーションの前提条件」を参照してください。

   重要

   キャッシュ インスタンスを作成した後でモジュールを変更することはできません。 モジュールは、Azure Cache for Redis インスタンスを作成するときに有効になっている必要があります。 キャッシュの作成後にモジュールの構成を有効にするオプションはありません。

6. タグ を選択してスキップします。

7. 確認と作成 をクリックします。

8. 設定を確認し、 [作成] を選択します。

   Redis インスタンスの作成には数分かかります。 Azure Managed Redis の [概要] ページで進行状況を監視できます。 [状態] に "実行中" と表示されている場合は、キャッシュを使用する準備ができています。

Azure Cache for Redis インスタンスを作成する

1. キャッシュを作成するには、Azure portal にサインインします。 ポータルのメニューで、[リソースの作成] を選びます。

   

2. [作業の開始] ペインの検索バーに「Azure Cache for Redis」と入力します。 検索結果で Azure Cache for Redis を見つけて、[作成] を選びます。

   

3. [新しい Redis Cache] ペインの [基本] タブで、以下のキャッシュの設定を構成します。

   設定	アクション	説明
   サブスクリプション	Azure サブスクリプションを選択します。	Azure Cache for Redis の新しいインスタンスの作成に使うサブスクリプション。
   リソース グループ	リソース グループを選択するか、 [新規作成] を選択し、新しいリソース グループの名前を入力します。	キャッシュや他のリソースを作成するリソース グループの名前。 すべてのアプリ リソースを 1 つのリソース グループに配置することで、それらをまとめて簡単に管理または削除できます。
   DNS 名	一意の名前を入力します。	キャッシュ名は、数字、英字、ハイフンのみを含む 1 から 63 文字の文字列とする必要があります。 名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。 キャッシュ インスタンスの "ホスト名" は \<DNS name>.redis.cache.windows.net です。
   場所	場所を選択します。	キャッシュを使う他のサービスに近い Azure リージョン。
   キャッシュ SKU	SKU を選びます。	SKU によって、キャッシュに利用できるサイズ、パフォーマンス、機能のパラメーターが決まります。 詳細については、Azure Cache for Redis の概要に関するページを参照してください。
   キャッシュ サイズ	キャッシュ サイズを選びます。	詳細については、Azure Cache for Redis の概要に関するページを参照してください。

4. [ネットワーク] タブを選ぶか、[次へ: ネットワーク] を選びます。

5. [ネットワーク] タブで、キャッシュに使う接続方法を選びます。

6. [詳細] タブを選ぶか、[次へ: 詳細] を選びます。

7. [詳細] ペインで、以下の情報に基づいて認証方法を確認または選択します。

   

   • 既定では、新しい Basic、Standard、または Premium キャッシュでは、Microsoft Entra 認証が有効になり、アクセス キー認証が無効になります。
   • Basic または Standard キャッシュの場合は、非 TLS ポートを選択できます。
   • Standard および Premium キャッシュの場合は、可用性ゾーンを有効にすることを選択できます。 キャッシュの作成後に可用性ゾーンを無効にすることはできません。
   • Premium キャッシュを利用する場合は、非 TLS ポート、クラスタリング、マネージド ID、データ永続化の設定を構成します。

   重要

   最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセス キーの認可より、セキュリティと使いやすさの点で優れています。 キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証への Microsoft Entra ID の使用に関する記事をご覧ください。

8. (省略可能) [タグ] タブを選ぶか、[次へ: タグ] を選びます。

9. (省略可能) キャッシュ リソースを分類する場合は、[タグ] タブでタグの名前と値を入力します。

10. [確認および作成] ボタンを選択します。

    [確認と作成] タブでは、Azure によって構成が自動的に検証されます。

11. 緑色の検証に成功のメッセージが表示された後、 [作成] を選択します。

新しいキャッシュのデプロイは数分で完了します。 デプロイの進行状況は、Azure Cache for Redis の [概要] ペインで監視できます。 [状態] に [実行中] と表示されたら、キャッシュを使用できます。

キャッシュ上で Microsoft Entra ID 認証を使用する

Azure Redis キャッシュでは、Enterprise および Enterprise Flash レベルを除き、既定で Microsoft Entra 認証が有効になっています。 アクセス キーは既定で無効になっています。

重要

Microsoft では、最も安全な認証エクスペリエンスのために、パスワードやアクセス キーの使用ではなく Microsoft Entra ID 認証の使用をお勧めしています。 本セクションで説明する認証ではアクセス キーを使用します。これにはアプリケーションの信頼性が極めて高いことが必要で、Microsoft Entra ID を使用する場合には存在しないリスクを伴います。 このドキュメントで紹介する手法は、Microsoft Entra ID 認証を実行できない場合にのみ使用してください。

1. Azure portal 内で、Microsoft Entra のトークン ベース認証を使用するキャッシュを選択します。

2. リソース メニューで [認証] を選択します。

3. [メンバーの選択] を選択し、有効なユーザーの名前を入力します。 [保存] を選択した場合は、既定で入力したユーザーに [データ所有者アクセス ポリシー] が自動的に割り当てられます。 マネージド ID またはサービス プリンシパルを入力して、キャッシュ インスタンスに接続することもできます。

   

Azure CLI で Microsoft Entra ID を使用する方法については、ID に関するリファレンス ページを参照してください。

Microsoft Entra ID 認証を使用するためのライブラリをインストールする

Azure.StackExchange.Redis ライブラリには、Microsoft Entra ID を使用して Azure Redis サービスに接続するための Microsoft Entra ID 認証方法が含まれています。 これは、すべての Azure Cache for Redis、Azure Cache for Redis Enterprise、および Azure Managed Redis (プレビュー) に適用されます。

dotnet add package Microsoft.Azure.StackExchangeRedis

---

Microsoft Entra ID を使用してキャッシュに接続する

1. コードにライブラリを含める

   using Azure.Identity;
   using StackExchange.Redis
   

2. 既定の Azure 資格情報を使用してクライアント接続を認証する。 これにより、コードをローカルで実行する場合はサインインしたユーザー資格情報を使用し、コードを変更せずに Azure で実行する場合は Azure マネージド ID を使用できます。

var configurationOptions = await ConfigurationOptions.Parse($"{_redisHostName}").ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential());
ConnectionMultiplexer _newConnection = await ConnectionMultiplexer.ConnectAsync(configurationOptions);
IDatabase Database = _newConnection.GetDatabase();

appsettings.json ファイルを編集するには

1. Web.config ファイルを編集します。 次の内容を追加します。

   "_redisHostName":"<cache-hostname>"
   

2. Azure portal の [リソース] メニューの [概要] セクションに表示されるキャッシュ ホスト名で <cache-hostname> を置き換えます。

   たとえば、Azure Managed Redis または Enterprise レベルの場合: my-redis.eastus.azure.net:10000

3. ファイルを保存します。

詳細については、StackExchange.Redis と、GitHub リポジトリのコードを参照してください。

appsettings.json ファイルを編集するには

1. appsettings.json ファイルを編集します。 次の内容を追加します。

   "_redisHostName":"<cache-hostname>"
   

2. Azure portal の [リソース] メニューの [概要] セクションに表示されるキャッシュ ホスト名で <cache-hostname> を置き換えます。

   たとえば、Azure Cache for Redis の場合: my-redis.eastus.azure.net:6380

3. ファイルを保存します。

詳細については、StackExchange.Redis と、GitHub リポジトリのコードを参照してください。

サンプルを実行する

開いているファイルがあれば保存し、次のコマンドを使用してアプリをビルドします。

dotnet build

.NET オブジェクトのシリアル化をテストするには、次のコマンドでアプリを実行します。

dotnet run

リソースをクリーンアップする

この記事で作成したリソースを引き続き使用する場合は、リソース グループを保持します。

それ以外の場合、リソースを使い終わったら、課金されないように、作成した Azure リソース グループを削除できます。

重要

リソース グループを削除すると、元に戻すことができません。 リソース グループを削除すると、そのリソース グループ内のすべてのリソースは完全に削除されます。 間違ったリソース グループやリソースをうっかり削除しないようにしてください。 リソースを既存のリソース グループ内に作成し、そのリソース グループ内に保持したいリソースが含まれている場合は、リソース グループを削除するのではなく、各リソースを個別に削除できます。

リソース グループを削除するには

1. Azure portal にサインインし、 [リソース グループ] を選択します。

2. 削除するリソース グループを選択します。

   多数のリソース グループがある場合は、[任意のフィールドのフィルター...] ボックスを使用し、この記事用に作成したリソース グループの名前を入力します。 結果リストでリソース グループを選びます。

   

3. [リソース グループの削除] を選択します。

4. リソース グループの削除の確認を求めるメッセージが表示されます。 確認のためにリソース グループの名前を入力し、[削除] を選択します。

   

しばらくすると、リソース グループとそのリソースのすべてが削除されます。

関連するコンテンツ

• 接続の回復力
• 開発のベスト プラクティス