如何在Azure API Management策略中创建列表并用于when条件判断？

问题核心 #

你在APIM的「所有操作」级别配置策略时，尝试通过<set-variable>定义列表变量用于when条件判断，但直接赋值"[a,b,c,d]"会被识别为字符串而非数组；同时Named Values不支持存储数组类型，最终目标是实现传入订阅密钥与预定义列表的匹配验证。

解决方案 #

APIM策略支持嵌入C#表达式，通过以下两种方式可以创建可在when条件中引用的列表：

方法1：直接在策略中定义C#数组

使用@(...)包裹C#数组初始化语法，将变量直接定义为数组类型：

<policies>
    <inbound>
        <base />
        <!-- 定义字符串数组类型的允许密钥列表 -->
        <set-variable name="allowedSubscriptionKeys" value="@(new string[] {"key-abc", "key-def", "key-ghi"})" />
        
        <!-- 验证传入的订阅密钥是否在列表中 -->
        <when condition="@(((string[])context.Variables["allowedSubscriptionKeys"]).Contains(context.Request.Headers.GetValueOrDefault("Ocp-Apim-Subscription-Key", "")))">
            <!-- 密钥匹配成功时执行的逻辑 -->
            <return-response>
                <set-status code="200" reason="OK" />
                <set-body>订阅密钥验证通过</set-body>
            </return-response>
        </when>
        <otherwise>
            <!-- 密钥匹配失败时执行的逻辑 -->
            <return-response>
                <set-status code="401" reason="Unauthorized" />
                <set-body>无效的订阅密钥</set-body>
            </return-response>
        </otherwise>
    </inbound>
</policies>

关键说明：在when条件中需要将context.Variables["allowedSubscriptionKeys"]显式转换为string[]类型，因为变量默认返回object类型，无法直接调用Contains方法。

方法2：通过Named Values存储逗号分隔字符串并转换为列表

如果需要更灵活地维护密钥列表（避免硬编码在策略中），可以将密钥以逗号分隔的形式存在Named Values中，再在策略中拆分转换为列表：

1. 在APIM的「Named Values」中创建一个条目，例如名称为AllowedSubscriptionKeys，值为key-abc,key-def,key-ghi
2. 在策略中读取并转换：

<policies>
    <inbound>
        <base />
        <!-- 从Named Values读取字符串，拆分并去除空格后转为列表 -->
        <set-variable name="allowedKeys" value="@(Environment.GetEnvironmentVariable("AllowedSubscriptionKeys").Split(',').Select(k => k.Trim()).ToList())" />
        
        <when condition="@(((List<string>)context.Variables["allowedKeys"]).Contains(context.Request.Headers.GetValueOrDefault("Ocp-Apim-Subscription-Key", "").Trim()))">
            <!-- 验证通过逻辑 -->
        </when>
        <otherwise>
            <!-- 验证失败逻辑 -->
        </otherwise>
    </inbound>
</policies>

关键说明：使用Select(k => k.Trim())可以避免因逗号前后空格导致的匹配失败问题，确保密钥格式一致。

为什么原写法无效 #

你之前直接赋值"[a,b,c,d]"是字符串字面量，APIM会将其作为普通字符串存储，而非解析为数组。只有用@(...)包裹的C#表达式才会被执行，从而创建真正的数组/列表对象。

内容的提问来源于stack exchange，提问作者Nikolai Rojahn