如何通过RegistryManager创建并上传Azure IoT Edge配置？

问题分析 #

Azure CLI可成功上传IoT Edge部署清单，但通过RegistryManager.AddConfigurationAsync上传时触发InvalidConfigurationContent错误，核心原因是手动将JSON反序列化为嵌套字典的方式，不符合SDK对ConfigurationContent结构的严格要求，导致上传内容格式不被IoT Hub认可。

解决方法 #

1. 直接反序列化为ConfigurationContent类型 #

不要将JSON手动解析为IDictionary<string, IDictionary<string, object>>，而是直接反序列化为SDK提供的ConfigurationContent类型，确保结构完全匹配IoT Hub的规范。

示例代码：

var registryManager = MsAzureDevicesNS.RegistryManager.CreateFromConnectionString(_IOTHubDevicesConfiguration.IOTHubConnectionString);

// 直接将JSON内容反序列化为ConfigurationContent
var configurationContent = JsonSerializer.Deserialize<ConfigurationContent>(
    edgeDeploymentModel.ConfigurationContent, 
    _jsonSerializerOptions
);

var configuration = new Configuration(edgeDeploymentModel.DeploymentId)
{
    Content = configurationContent,
    TargetCondition = edgeDeploymentModel.TargetCondition,
    Priority = edgeDeploymentModel.Priority,
    // 创建新部署时无需指定空ETag，移除该配置
};

await registryManager.AddConfigurationAsync(configuration);

2. 校准JSON序列化配置 #

确保_jsonSerializerOptions与部署文件的格式匹配：

• 若JSON使用驼峰命名，启用PropertyNameCaseInsensitive = true
• 若JSON包含注释，添加AllowTrailingCommas = true和ReadCommentHandling = JsonCommentHandling.Skip

示例配置：

var _jsonSerializerOptions = new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    AllowTrailingCommas = true,
    ReadCommentHandling = JsonCommentHandling.Skip,
    WriteIndented = true
};

3. 验证反序列化结构 #

调试时检查configurationContent.ModulesContent的结构，确保包含$edgeAgent、$edgeHub等必填顶层键，且子结构与原始JSON完全一致。若结构不符，说明序列化选项存在问题。

4. 切换序列化库（备选） #

如果System.Text.Json仍有兼容性问题，可尝试改用Newtonsoft.Json（Azure SDK早期版本对其支持更完善）：

using Newtonsoft.Json;

var configurationContent = JsonConvert.DeserializeObject<ConfigurationContent>(
    edgeDeploymentModel.ConfigurationContent
);

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