ContainerProperties.DefaultTimeToLive プロパティ

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

ソース:

ContainerProperties.cs

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)

プロパティ値

Nullable<Int32>

これは省略可能なプロパティです。

測定単位は秒です。 許容される最大値は2147483647。 有効な値は、0 以外の正の整数 '-1' または nullのいずれかである必要があります。

既定では、DefaultTimeToLive は null に設定されています。これは、コンテナーの有効期間がオフになっていることを意味します。

属性

Newtonsoft.Json.JsonPropertyAttribute

例

次の例では、コンテナーの有効期間を無効にします。

container.DefaultTimeToLive = null;

次の例では、コンテナーでの有効期間を有効にします。 既定では、すべてのアイテムの有効期限は切れません。

container.DefaultTimeToLive = -1;

次の例では、コンテナーでの有効期間を有効にします。 既定では、アイテムは最後の書き込み時刻から 1,000 秒後に期限切れになります。

container.DefaultTimeToLive = 1000;

注釈

DefaultTimeToLiveは、コンテナー内のすべての項目に既定の有効期間ポリシーとして適用されます。 個々のアイテムは、その時間をライブに設定することで、既定の有効期間ポリシーをオーバーライドできます。

DefaultTimeToLiveが nullの場合、コンテナーの有効期間はオフになります。 これは、すべてのアイテムが期限切れになることはないことを意味します。 個々のアイテムの有効期間は無視されます。

DefaultTimeToLiveが '-1' の場合、コンテナーの有効期間が有効になります。 既定では、すべてのアイテムの有効期限は切れません。 個々のアイテムには、その時間をライブに設定することで、特定の有効期間の値を指定できます。 アイテムの有効期間が優先され、期限切れのアイテムはバックグラウンドで削除されます。

DefaultTimeToLiveが 0 以外の正の整数の場合、コンテナーの有効期間が有効になります。 また、既定の有効期間 (秒単位) がすべてのアイテムに適用されます。 アイテムは、最後の書き込み時刻から指定した DefaultTimeToLive 値 (秒単位) の後に期限切れになります。