Azure API Management で外部の Azure Cache for Redis を使用するUse an external Azure Cache for Redis in Azure API Management

Azure API Management では、組み込みのキャッシュを利用できるだけでなく、外部の Azure Cache for Redis に応答をキャッシュすることもできます。In addition to utilizing the built-in cache, Azure API Management also allows for caching responses in an external Azure Cache for Redis.

外部キャッシュを使用すると、組み込みキャッシュに関するいくつかの制限事項を回避することができます。Using an external cache allows to overcome a few limitations of the built-in cache. これは、次の目的がある場合は特に便利です。It is especially beneficial if you would like to:

  • API Management の更新時にキャッシュが定期的に消去されるのを避けるAvoid having your cache periodically cleared during API Management updates
  • キャッシュの構成をより細かく制御するHave more control over your cache configuration
  • ご利用の API Management レベルより多くのデータをキャッシュするCache more data than your API Management tier allows to
  • API Management の従量課金レベルでキャッシュを使用するUse caching with the Consumption tier of API Management

キャッシュの詳細については、「API Management のキャッシュ ポリシー」と「Azure API Management のカスタム キャッシュ」を参照してください。For more detailed information about caching, see API Management caching policies and Custom caching in Azure API Management.

APIM にお客様のキャッシュを追加する

ここでは、次の内容について学習します。What you'll learn:

  • API Management に外部キャッシュを追加するAdd an external cache in API Management

前提条件Prerequisites

このチュートリアルを完了するには、以下を実行する必要があります。To complete this tutorial, you need to:

Azure Cache for Redis を作成する Create Azure Cache for Redis

このセクションでは、Azure 内に Azure Cache for Redis を作成する方法について説明します。This section explains how to create an Azure Cache for Redis in Azure. Azure の内部または外部に Azure Cache for Redis が既にある場合は、次のセクションにスキップできます。If you already have an Azure Cache for Redis, within or outside of Azure, you can skip to the next section.

  1. キャッシュを作成するには、まず Azure portal にサインインします。To create a cache, first sign in to the Azure portal. [リソースの作成] > [データベース] > [Azure Cache for Redis] を選択します。Then select Create a resource > Databases > Azure Cache for Redis.

    新しいキャッシュ

  2. [New Azure Cache for Redis](新規 Azure Cache for Redis) で、新しいキャッシュの設定を構成します。In New Azure Cache for Redis, configure the settings for your new cache.

    SettingSetting 推奨値Suggested value 説明Description
    DNS 名DNS name グローバルに一意の名前Globally unique name キャッシュ名。The cache name. 1 から 63 文字の文字列で、数字、英字、- 文字のみを使用する必要があります。It must be a string between 1 and 63 characters and contain only numbers, letters, and the - character. キャッシュ名の先頭と末尾には - 文字を使用できません。また、連続する - 文字は無効です。The cache name cannot start or end with the - character, and consecutive - characters are not valid.
    サブスクリプションSubscription 該当するサブスクリプションYour subscription この新しい Azure Cache for Redis インスタンスが作成されるサブスクリプション。The subscription under which this new Azure Cache for Redis instance is created.
    リソース グループResource group TestResourcesTestResources その中にキャッシュを作成する新しいリソース グループの名前。Name for the new resource group in which to create your cache. アプリのすべてのリソースを 1 つのグループ内に配置することで、それらを一緒に管理できます。By putting all the resources for an app in a group, you can manage them together. たとえば、リソース グループを削除すると、そのアプリに関連付けられているすべてのリソースが削除されます。For example, deleting the resource group deletes all resources that are associated with the app.
    LocationLocation 米国東部East US キャッシュを使用する他のサービスの近くのリージョンを選択します。Choose a region near to other services that will use your cache.
    価格レベルPricing tier Basic C0 (250 MB のキャッシュ)Basic C0 (250 MB Cache) 価格レベルによって、キャッシュに使用できるのサイズ、パフォーマンス、および機能が決まります。The pricing tier determines the size, performance, and features that are available for the cache. 詳細については、Azure Cache for Redis の概要に関するページを参照してください。For more information, see Azure Cache for Redis Overview.
    ダッシュボードにピン留めするPin to dashboard オンSelected 新しいキャッシュをダッシュボードにピン留めし、簡単に見つけられるようにします。Pin the new cache to your dashboard to make it easy to find.

    キャッシュの作成

  3. 新しいキャッシュ設定を構成したら、 [作成] を選択します。After the new cache settings are configured, select Create.

    キャッシュが作成されるまで数分かかる場合があります。It can take a few minutes for the cache to be created. 状態を確認するには、ダッシュボードで進行状況を監視してください。To check the status, you can monitor the progress on the dashboard. キャッシュが作成されると、実行中の状態が表示され、使用できるようになります。After the cache has been created, it shows the status Running, and is ready for use.

    作成されたキャッシュ

外部キャッシュの追加 Add an external cache

Azure API Management に外部の Azure Cache for Redis を追加するには、次の手順に従います。Follow the steps below to add an external Azure Cache for Redis in Azure API Management.

APIM にお客様のキャッシュを追加する

注意

[Use from](使用元) 設定では、API Management がマルチリージョン構成である場合に、API Management のどのリージョンのデプロイが構成済みのキャッシュと通信するのかを指定します。The Use from setting specifies which API Management regional deployment will communicate with the configured cache in case of a multi-regional configuration of API Management. 既定として指定されたキャッシュは、リージョンの値を使ったキャッシュによって上書きされます。The caches specified as Default will be overridden by caches with a regional value.

たとえば、API Management が米国東部、東南アジア、および西ヨーロッパのリージョンでホストされていて、2 つのキャッシュ (1 つは既定、もう 1 つは東南アジア用) が構成されている場合、東南アジアの API Management ではそのリージョンのキャッシュが使用され、他の 2 つのリージョンでは既定のキャッシュ エントリが使用されます。For example, if API Management is hosted in the East US, Southeast Asia and West Europe regions and there are two caches configured, one for Default and one for Southeast Asia, API Management in Southeast Asia will use its own cache, while the other two regions will use the Default cache entry.

同じサブスクリプションから Azure Cache for Redis を追加するAdd an Azure Cache for Redis from the same subscription

  1. Azure portal で API Management インスタンスを参照します。Browse to your API Management instance in the Azure portal.
  2. 左側のメニューから [External cache](外部キャッシュ) タブを選択します。Select the External cache tab from the menu on the left.
  3. [+ 追加] ボタンをクリックします。Click the + Add button.
  4. [Cache instance](キャッシュ インスタンス) ドロップダウン フィールドでキャッシュを選択します。Select your cache in the Cache instance dropdown field.
  5. [既定] を選択するか、 [Use from](使用元) ドロップダウン フィールドで目的のリージョンを指定します。Select Default or specify the desired region in the Use from dropdown field.
  6. [Save] をクリックします。Click Save.

現在の Azure サブスクリプションまたは一般の Azure の外部でホストされている Azure Cache for Redis を追加しますAdd an Azure Cache for Redis hosted outside of the current Azure subscription or Azure in general

  1. Azure portal で API Management インスタンスを参照します。Browse to your API Management instance in the Azure portal.
  2. 左側のメニューから [External cache](外部キャッシュ) タブを選択します。Select the External cache tab from the menu on the left.
  3. [+ 追加] ボタンをクリックします。Click the + Add button.
  4. [Cache instance](キャッシュ インスタンス) ドロップダウン フィールドで [カスタム] を選択します。Select Custom in the Cache instance dropdown field.
  5. [既定] を選択するか、 [Use from](使用元) ドロップダウン フィールドで目的のリージョンを指定します。Select Default or specify the desired region in the Use from dropdown field.
  6. [接続文字列] フィールドで Azure Cache for Redis の接続文字列を指定します。Provide your Azure Cache for Redis connection string in the Connection string field.
  7. [Save] をクリックします。Click Save.

外部キャッシュの使用Use the external cache

Azure API Management で外部キャッシュが構成されたら、キャッシュ ポリシーを通じてそのキャッシュを使用できます。Once the external cache is configured in Azure API Management, it can be used through caching policies. 詳しい手順については、「キャッシュを追加して Azure API Management のパフォーマンスを向上させる」をご覧ください。See Add caching to improve performance in Azure API Management for detailed steps.

次のステップ Next steps