xml/Azure.Cosmos/CosmosClientOptions.xml

<Type Name="CosmosClientOptions" FullName="Azure.Cosmos.CosmosClientOptions">
  <TypeSignature Language="C#" Value="public class CosmosClientOptions : Azure.Core.ClientOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CosmosClientOptions extends Azure.Core.ClientOptions" />
  <TypeSignature Language="DocId" Value="T:Azure.Cosmos.CosmosClientOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class CosmosClientOptions&#xA;Inherits ClientOptions" />
  <TypeSignature Language="F#" Value="type CosmosClientOptions = class&#xA;    inherit ClientOptions" />
  <AssemblyInfo>
    <AssemblyName>Azure.Cosmos</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Core.ClientOptions</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Defines all the configurable options that the CosmosClient requires.
            </summary>
    <remarks>To be added.</remarks>
    <example>
            An example on how to configure the serialization option to ignore null values
            CosmosClientOptions clientOptions = new CosmosClientOptions()
            {
                SerializerOptions = new CosmosSerializationOptions(){
                    IgnoreNullValues = true
                },
                ConnectionMode = ConnectionMode.Gateway,
            };
            
            CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);
            </example>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CosmosClientOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Cosmos.CosmosClientOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Creates a new CosmosClientOptions
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplicationName">
      <MemberSignature Language="C#" Value="public string ApplicationName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ApplicationName" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.ApplicationName" />
      <MemberSignature Language="VB.NET" Value="Public Property ApplicationName As String" />
      <MemberSignature Language="F#" Value="member this.ApplicationName : string with get, set" Usage="Azure.Cosmos.CosmosClientOptions.ApplicationName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set user-agent suffix to include with every Azure Cosmos DB service interaction.
            </summary>
        <value>To be added.</value>
        <remarks>
            Setting this property after sending any request won't have any effect.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplicationRegion">
      <MemberSignature Language="C#" Value="public string ApplicationRegion { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ApplicationRegion" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.ApplicationRegion" />
      <MemberSignature Language="VB.NET" Value="Public Property ApplicationRegion As String" />
      <MemberSignature Language="F#" Value="member this.ApplicationRegion : string with get, set" Usage="Azure.Cosmos.CosmosClientOptions.ApplicationRegion" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set the preferred geo-replicated region to be used for Azure Cosmos DB service interaction.
            </summary>
        <value>To be added.</value>
        <remarks>
            When this property is specified, the SDK prefers the region to perform operations. Also SDK auto-selects 
            fallback geo-replicated regions for high availability. 
            When this property is not specified, the SDK uses the write region as the preferred region for all operations.
            
            <seealso cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithApplicationRegion(System.String)" /><seealso href="https://docs.microsoft.com/azure/cosmos-db/how-to-multi-master" /></remarks>
      </Docs>
    </Member>
    <Member MemberName="ConnectionMode">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.ConnectionMode ConnectionMode { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Cosmos.ConnectionMode ConnectionMode" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.ConnectionMode" />
      <MemberSignature Language="VB.NET" Value="Public Property ConnectionMode As ConnectionMode" />
      <MemberSignature Language="F#" Value="member this.ConnectionMode : Azure.Cosmos.ConnectionMode with get, set" Usage="Azure.Cosmos.CosmosClientOptions.ConnectionMode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.ConnectionMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set the connection mode used by the client when connecting to the Azure Cosmos DB service.
            </summary>
        <value>
            Default value is <see cref="F:Azure.Cosmos.ConnectionMode.Direct" /></value>
        <remarks>
            For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
            </remarks>
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeGateway(System.Nullable{System.Int32},System.Net.IWebProxy)" />
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeDirect" />
      </Docs>
    </Member>
    <Member MemberName="ConsistencyLevel">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.ConsistencyLevel? ConsistencyLevel { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Azure.Cosmos.ConsistencyLevel&gt; ConsistencyLevel" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.ConsistencyLevel" />
      <MemberSignature Language="VB.NET" Value="Public Property ConsistencyLevel As Nullable(Of ConsistencyLevel)" />
      <MemberSignature Language="F#" Value="member this.ConsistencyLevel : Nullable&lt;Azure.Cosmos.ConsistencyLevel&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.ConsistencyLevel" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Azure.Cosmos.ConsistencyLevel&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            This can be used to weaken the database account consistency level for read operations.
            If this is not set the database account consistency level will be used for all requests.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GatewayModeMaxConnectionLimit">
      <MemberSignature Language="C#" Value="public int GatewayModeMaxConnectionLimit { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 GatewayModeMaxConnectionLimit" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.GatewayModeMaxConnectionLimit" />
      <MemberSignature Language="VB.NET" Value="Public Property GatewayModeMaxConnectionLimit As Integer" />
      <MemberSignature Language="F#" Value="member this.GatewayModeMaxConnectionLimit : int with get, set" Usage="Azure.Cosmos.CosmosClientOptions.GatewayModeMaxConnectionLimit" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set the maximum number of concurrent connections allowed for the target
            service endpoint in the Azure Cosmos DB service.
            </summary>
        <value>Default value is 50.</value>
        <remarks>
            This setting is only applicable in Gateway mode.
            </remarks>
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithConnectionModeGateway(System.Nullable{System.Int32},System.Net.IWebProxy)" />
      </Docs>
    </Member>
    <Member MemberName="IdleTcpConnectionTimeout">
      <MemberSignature Language="C#" Value="public TimeSpan? IdleTcpConnectionTimeout { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; IdleTcpConnectionTimeout" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.IdleTcpConnectionTimeout" />
      <MemberSignature Language="VB.NET" Value="Public Property IdleTcpConnectionTimeout As Nullable(Of TimeSpan)" />
      <MemberSignature Language="F#" Value="member this.IdleTcpConnectionTimeout : Nullable&lt;TimeSpan&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.IdleTcpConnectionTimeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            (Direct/TCP) Controls the amount of idle time after which unused connections are closed.
            </summary>
        <value>
            By default, idle connections are kept open indefinitely. Value must be greater than or equal to 10 minutes. Recommended values are between 20 minutes and 24 hours.
            </value>
        <remarks>
            Mainly useful for sparse infrequent access to a large database account.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="LimitToEndpoint">
      <MemberSignature Language="C#" Value="public bool LimitToEndpoint { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool LimitToEndpoint" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.LimitToEndpoint" />
      <MemberSignature Language="VB.NET" Value="Public Property LimitToEndpoint As Boolean" />
      <MemberSignature Language="F#" Value="member this.LimitToEndpoint : bool with get, set" Usage="Azure.Cosmos.CosmosClientOptions.LimitToEndpoint" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Limits the operations to the provided endpoint on the CosmosClient.
            </summary>
        <value>
            Default value is false.
            </value>
        <remarks>
            When the value of this property is false, the SDK will automatically discover write and read regions, and use them when the configured application region is not available.
            When set to true, availability is limited to the endpoint specified on the CosmosClient constructor.
            Defining the <see cref="P:Azure.Cosmos.CosmosClientOptions.ApplicationRegion" /> is not allowed when setting the value to true.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="MaxRequestsPerTcpConnection">
      <MemberSignature Language="C#" Value="public int? MaxRequestsPerTcpConnection { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MaxRequestsPerTcpConnection" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.MaxRequestsPerTcpConnection" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxRequestsPerTcpConnection As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MaxRequestsPerTcpConnection : Nullable&lt;int&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.MaxRequestsPerTcpConnection" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            (Direct/TCP) Controls the number of requests allowed simultaneously over a single TCP connection. When more requests are in flight simultaneously, the direct/TCP client will open additional connections.
            </summary>
        <value>
            The default settings allow 30 simultaneous requests per connection.
            Do not set this value lower than 4 requests per connection or higher than 50-100 requests per connection.       
            The former can lead to a large number of connections to be created. 
            The latter can lead to head of line blocking, high latency and timeouts.
            </value>
        <remarks>
            Applications with a very high degree of parallelism per connection, with large requests or responses, or with very tight latency requirements might get better performance with 8-16 requests per connection.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="MaxRetryAttemptsOnRateLimitedRequests">
      <MemberSignature Language="C#" Value="public int? MaxRetryAttemptsOnRateLimitedRequests { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MaxRetryAttemptsOnRateLimitedRequests" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.MaxRetryAttemptsOnRateLimitedRequests" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxRetryAttemptsOnRateLimitedRequests As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MaxRetryAttemptsOnRateLimitedRequests : Nullable&lt;int&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.MaxRetryAttemptsOnRateLimitedRequests" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set the number of times client should retry on rate throttled requests.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithThrottlingRetryOptions(System.TimeSpan,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="MaxRetryWaitTimeOnRateLimitedRequests">
      <MemberSignature Language="C#" Value="public TimeSpan? MaxRetryWaitTimeOnRateLimitedRequests { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; MaxRetryWaitTimeOnRateLimitedRequests" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxRetryWaitTimeOnRateLimitedRequests As Nullable(Of TimeSpan)" />
      <MemberSignature Language="F#" Value="member this.MaxRetryWaitTimeOnRateLimitedRequests : Nullable&lt;TimeSpan&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get or set the max time to client is allowed to retry on rate throttled requests. 
            </summary>
        <value>To be added.</value>
        <remarks>
            The minimum interval is seconds. Any interval that is smaller will be ignored.
            </remarks>
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithThrottlingRetryOptions(System.TimeSpan,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="MaxTcpConnectionsPerEndpoint">
      <MemberSignature Language="C#" Value="public int? MaxTcpConnectionsPerEndpoint { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MaxTcpConnectionsPerEndpoint" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.MaxTcpConnectionsPerEndpoint" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxTcpConnectionsPerEndpoint As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MaxTcpConnectionsPerEndpoint : Nullable&lt;int&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.MaxTcpConnectionsPerEndpoint" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            (Direct/TCP) Controls the maximum number of TCP connections that may be opened to each Cosmos DB back-end.
            Together with MaxRequestsPerTcpConnection, this setting limits the number of requests that are simultaneously sent to a single Cosmos DB back-end(MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint).
            </summary>
        <value>
            The default value is 65,535. Value must be greater than or equal to 16.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OpenTcpConnectionTimeout">
      <MemberSignature Language="C#" Value="public TimeSpan? OpenTcpConnectionTimeout { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; OpenTcpConnectionTimeout" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.OpenTcpConnectionTimeout" />
      <MemberSignature Language="VB.NET" Value="Public Property OpenTcpConnectionTimeout As Nullable(Of TimeSpan)" />
      <MemberSignature Language="F#" Value="member this.OpenTcpConnectionTimeout : Nullable&lt;TimeSpan&gt; with get, set" Usage="Azure.Cosmos.CosmosClientOptions.OpenTcpConnectionTimeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            (Direct/TCP) Controls the amount of time allowed for trying to establish a connection.
            </summary>
        <value>
            The default timeout is 5 seconds. Recommended values are greater than or equal to 5 seconds.
            </value>
        <remarks>
            When the time elapses, the attempt is cancelled and an error is returned. Longer timeouts will delay retries and failures.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="RequestTimeout">
      <MemberSignature Language="C#" Value="public TimeSpan RequestTimeout { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan RequestTimeout" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.RequestTimeout" />
      <MemberSignature Language="VB.NET" Value="Public Property RequestTimeout As TimeSpan" />
      <MemberSignature Language="F#" Value="member this.RequestTimeout : TimeSpan with get, set" Usage="Azure.Cosmos.CosmosClientOptions.RequestTimeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.TimeSpan</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the request timeout in seconds when connecting to the Azure Cosmos DB service.
            The number specifies the time to wait for response to come back from network peer.
            </summary>
        <value>Default value is 1 minute.</value>
        <remarks>To be added.</remarks>
        <altmember cref="M:Azure.Cosmos.Fluent.CosmosClientBuilder.WithRequestTimeout(System.TimeSpan)" />
      </Docs>
    </Member>
    <Member MemberName="Serializer">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.Serialization.CosmosSerializer Serializer { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Azure.Cosmos.Serialization.CosmosSerializer Serializer" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.Serializer" />
      <MemberSignature Language="VB.NET" Value="Public Property Serializer As CosmosSerializer" />
      <MemberSignature Language="F#" Value="member this.Serializer : Azure.Cosmos.Serialization.CosmosSerializer with get, set" Usage="Azure.Cosmos.CosmosClientOptions.Serializer" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.Serialization.CosmosSerializer</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            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.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <example>
            // 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);
            </example>
      </Docs>
    </Member>
    <Member MemberName="SerializerOptions">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.Serialization.CosmosSerializationOptions SerializerOptions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Azure.Cosmos.Serialization.CosmosSerializationOptions SerializerOptions" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.SerializerOptions" />
      <MemberSignature Language="VB.NET" Value="Public Property SerializerOptions As CosmosSerializationOptions" />
      <MemberSignature Language="F#" Value="member this.SerializerOptions : Azure.Cosmos.Serialization.CosmosSerializationOptions with get, set" Usage="Azure.Cosmos.CosmosClientOptions.SerializerOptions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.Serialization.CosmosSerializationOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Get to set optional serializer options.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <example>
            An example on how to configure the serialization option to ignore null values
            CosmosClientOptions clientOptions = new CosmosClientOptions()
            {
                SerializerOptions = new CosmosSerializationOptions(){
                    IgnoreNullValues = true
                }
            };
            
            CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);
            </example>
      </Docs>
    </Member>
    <Member MemberName="WebProxy">
      <MemberSignature Language="C#" Value="public System.Net.IWebProxy WebProxy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy WebProxy" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.CosmosClientOptions.WebProxy" />
      <MemberSignature Language="VB.NET" Value="Public Property WebProxy As IWebProxy" />
      <MemberSignature Language="F#" Value="member this.WebProxy : System.Net.IWebProxy with get, set" Usage="Azure.Cosmos.CosmosClientOptions.WebProxy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.IWebProxy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            (Gateway/Https) Get or set the proxy information used for web requests.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>