CosmosClientOptions.Serializer Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
CosmosClientOptions.cs

Get to set an optional JSON serializer. The client will use it to serialize or de-serialize user's cosmos request/responses. SDK owned types such as DatabaseProperties and ContainerProperties will always use the SDK default serializer.

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Cosmos.CosmosClientOptions+ClientOptionJsonConverter))]
public Microsoft.Azure.Cosmos.CosmosSerializer Serializer { get; set; }
[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Cosmos.CosmosClientOptions+ClientOptionJsonConverter))>]
member this.Serializer : Microsoft.Azure.Cosmos.CosmosSerializer with get, set
Public Property Serializer As CosmosSerializer

Property Value

CosmosSerializer
Attributes
Newtonsoft.Json.JsonConverterAttribute

Examples

An example on how to set a custom serializer. For basic serializer options look at CosmosSerializationOptions

CosmosSerializer ignoreNullSerializer = new MyCustomIgnoreNullSerializer();

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    Serializer = ignoreNullSerializer
};

CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);

Applies to