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