Share via

ContainerProperties.TimeToLivePropertyPath Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.45.0
Source:
ContainerProperties.cs

Caution

This API is now deprecated.

Gets or sets the time to live base time stamp property path.

[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")]
[System.Obsolete]
public string TimeToLivePropertyPath { get; set; }
[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")>]
[<System.Obsolete>]
member this.TimeToLivePropertyPath : string with get, set
Public Property TimeToLivePropertyPath As String

Property Value

String

It is an optional property. This property should be only present when DefaultTimeToLive is set. When this property is present, time to live for a item is decided based on the value of this property in item. By default, TimeToLivePropertyPath is set to null meaning the time to live is based on the _ts property in item.

Attributes
Newtonsoft.Json.JsonPropertyAttribute ObsoleteAttribute

Applies to