從快取中取得值
適用於:所有 APIM 層
使用 cache-lookup-value
原則以執行依索引鍵的快取查閱,並傳回快取的值。 金鑰可以具有任意字串值,而且通常會使用原則運算式來提供。
注意
此原則必須有對應的儲存快取中的值原則。
重要
內建快取具揮發性,且相同區域的所有單位共用相同的 API 管理服務。
注意
請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則。
原則陳述式
<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" />
屬性
屬性 | 描述 | 是必要欄位 | 預設 |
---|---|---|---|
caching-type | 選擇下列屬性值: - internal ,使用內建的 APIM 快取,- external ,使用外部快取,如在 Azure API 管理中使用外部 Azure Redis 快取中所述,- prefer-external 。如有設定,則使用外部快取;否則使用內部快取。不允許使用原則運算式。 |
No | prefer-external |
default-value | 當快取索引鍵查閱沒有結果時,要指派給變數的值。 如果未指定此屬性,則會指派 null 。 允許使用原則運算式。 |
No | null |
索引鍵 | 要在查閱中使用的快取索引鍵值。 允許使用原則運算式。 | Yes | N/A |
變數名稱 | 查閱成功時,要將查閱到的值指派到之內容變數的名稱。 如果查閱結果遺漏,則不會設定變數。 不允許使用原則運算式。 | Yes | N/A |
使用方式
範例
<cache-lookup-value
key="@("userprofile-" + context.Variables["enduserid"])"
variable-name="userprofile" />
如需此原則的詳細資訊和範例,請參閱在 Azure API 管理中自訂快取。
相關原則
相關內容
如需使用原則的詳細資訊,請參閱:
- 教學課程:轉換及保護 API
- 原則參考,取得原則陳述式及其設定的完整清單
- 原則運算式
- 設定或編輯原則
- 重複使用原則設定
- 原則程式碼片段存放庫 (英文)
- 使用 Microsoft Azure Copilot 撰寫原則