Cosmos DB DbContext查询返回空结果，HasName映射配置不生效问题

问题根因 #

你当前使用的HasKey().HasName()是EF Core针对关系型数据库设计的列名配置方法，在Cosmos DB（文档型数据库）的EF Core Provider中不生效。Cosmos DB的字段映射需要使用专用的ToJsonProperty()方法完成C#属性和JSON文档字段的绑定。
你当前的配置下，EF Core默认会将C#实体的Id属性映射到JSON文档的Id字段，但Cosmos DB默认的主键字段为小写的id，二者无法匹配，所以查询时无法正确反序列化已存在的文档，返回结果为空。

正确配置方法 #

修改你的Settings实体配置类代码即可，无需修改实体属性名：

// 配置主键
builder.HasKey(x => x.Id);
// 配置分区键
builder.HasPartitionKey(x => x.Id);
// 新增：将C#属性Id映射到Cosmos文档的id字段
builder.Property(x => x.Id).ToJsonProperty("id");

补充说明 #

• 该配置可以保留C#实体大驼峰的命名规范，无需将属性改为小写id
• 如果存在其他C#属性名和Cosmos文档字段名不一致的场景，都可以通过ToJsonProperty()方法配置映射关系
• 配置完成后读写操作都会自动完成字段名的转换，无需额外手动处理

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