你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ContainerProperties.DefaultTimeToLive 属性

定义

获取或设置 Azure Cosmos 服务容器中项的默认生存时间(以秒为单位)。

[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")]
public int? DefaultTimeToLive { get; set; }
[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")>]
member this.DefaultTimeToLive : Nullable<int> with get, set
Public Property DefaultTimeToLive As Nullable(Of Integer)

属性值

它是一个可选属性。

度量单位为秒。 允许的最大值为 2147483647。 有效值必须是非零正整数“-1”或 null

默认情况下,DefaultTimeToLive 设置为 null,这意味着关闭容器的生存时间。

属性
Newtonsoft.Json.JsonPropertyAttribute

示例

以下示例禁用容器上的生存时间。

container.DefaultTimeToLive = null;

以下示例在容器上启用生存时间。 默认情况下,所有项永不过期。

container.DefaultTimeToLive = -1;

以下示例在容器上启用生存时间。 默认情况下,该项将在自上次写入时间起 1000 秒后过期。

container.DefaultTimeToLive = 1000;

注解

DefaultTimeToLive将应用于容器中的所有项,作为默认生存时间策略。 单个项可以通过设置生存时间来替代默认生存时间策略。

DefaultTimeToLive当 为 null时,将关闭容器的生存时间。 这意味着所有项永远不会过期。 将忽略单个项目的生存时间。

当 为 DefaultTimeToLive “-1”时,将为容器打开生存时间。 默认情况下,所有项永远不会过期。 通过设置单个项目的生存时间,可以为其指定特定的生存时间值。 项目的生存时间将被遵循,过期的项目将在后台删除。

DefaultTimeToLive当 为非零正整数时,将为容器打开生存时间。 默认生存时间(以秒为单位)将应用于所有项。 项将在指定 DefaultTimeToLive 值(以秒为单位)之后自上次写入后过期。

适用于