Azure APIM ARM部署时apis/operations的representations.sample未生效问题求解

云上老周

2026-10-6

背景

我通过ARM模板部署开发/生产环境的APIM实例，其中一个API接收application/xml格式的请求正文。如果在Azure门户中手动添加该配置，配置可以正常保存并在开发者门户展示：
APIM添加请求正文示例

我提取配置后部署到生产APIM实例时，能在代码和Azure部署日志中确认示例表示已包含在ARM模板中：
门户中ARM部署记录

但xml示例部分实际未部署成功，生产实例中该字段为空：
生产环境请求表示示例

已尝试的解决方案

我找到相关资料早在2017年就提到了该问题，但我不想因为这一个bug更改整套部署策略。
我尝试将其添加为定义，因为JSON响应定义可以正常工作，但定义仅支持JSON格式，不支持XML。
我测试了多种representations.contentType/representations.sample组合，均无法通过ARM部署成功（门户中示例字段为空），因此问题应该和特殊字符无关。

相关测试配置参考：

"representations": [
            {
              "contentType": "application/xml",
              "sample": "Hello World"
            },
            {
              "contentType": "application/json",
              "sample": "Hello World"
            },
            {
              "contentType": "text/plain",
              "sample": "Hello World"
            },
            {
              "contentType": "text/xml",
              "sample": "<xml></xml>"
            },
            {
              "contentType": "text/xml",
              "sample": "&lt;xml&gt;&lt;/xml&gt;"
            }
          ]