Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ConnectionPolicy.IdleTcpConnectionTimeout Property

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

(Direct/TCP) Controls the amount of idle time after which unused connections are closed.

public TimeSpan? IdleTcpConnectionTimeout { get; set; }
member this.IdleTcpConnectionTimeout : Nullable<TimeSpan> with get, set
Public Property IdleTcpConnectionTimeout As Nullable(Of TimeSpan)

Property 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.

Remarks

Mainly useful for sparse infrequent access to a large database account.

Applies to

Feedback

Was this page helpful?