値をキャッシュに格納
適用対象: すべての API Management レベル
cache-store-value
は、キーごとに記憶域のキャッシュを実行します。 キーには任意の文字列値を設定でき、通常はポリシー式を使用して指定します。
Note
このポリシーによって実行される、キャッシュに値を格納する操作は非同期です。 格納された値は、キャッシュから値を取得ポリシーを使用して取得できます。 ただし、キャッシュに値を格納する非同期操作がまだ進行中である可能性もあるため、格納されている値をすぐに使用できない場合があります。
重要
組み込みのキャッシュは揮発性であり、同じ API Management サービスの同じリージョン内のすべてのユニットによって共有されます。
Note
ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。
ポリシー ステートメント
<cache-store-value key="cache key value" value="value to cache" duration="seconds" caching-type="prefer-external | external | internal" />
属性
属性 | 説明 | 必要 | Default |
---|---|---|---|
caching-type | 属性の次の値のいずれかを選択します。 - internal (組み込みの API Management キャッシュを使用する場合)、- external (- に関するページの説明に従って、外部キャッシュを使用する場合)、- prefer-external (構成されている場合は外部キャッシュ、そうでない場合は内部キャッシュを使用する場合)。ポリシー式は使用できません。 |
いいえ | prefer-external |
duration | 指定された期間 (秒単位)、値がキャッシュされます。 ポリシー式を使用できます。 | はい | 該当なし |
key | 値が格納されるキャッシュのキー。 ポリシー式を使用できます。 | はい | 該当なし |
value | キャッシュされる値。 ポリシー式を使用できます。 | はい | 該当なし |
使用法
- ポリシー セクション: inbound、outbound、backend、on-error
- ポリシー スコープ: グローバル、ワークスペース、製品、API、操作
- ゲートウェイ: クラシック、v2、従量課金、セルフホステッド、ワークスペース
例
<cache-store-value
key="@("userprofile-" + context.Variables["enduserid"])"
value="@((string)context.Variables["userprofile"])" duration="100000" />
このポリシーの詳細と例については、「Custom caching in Azure API Management」(Azure API Management でのカスタム キャッシュ) を参照してください。
関連ポリシー
関連するコンテンツ
ポリシーに対する処理の詳細については、次のトピックを参照してください。
- チュートリアル:API を変換および保護する
- ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
- ポリシー式
- ポリシーの設定または編集
- ポリシー構成を再利用する
- ポリシー スニペットのリポジトリ
- Azure で Microsoft Copilot を使用してポリシーを作成する