HealthInformation.TimeToLive Property

Definition

Gets or sets how long the health report is valid. Must be larger than TimeSpan.Zero.

public TimeSpan TimeToLive { get; set; }
member this.TimeToLive : TimeSpan with get, set
Public Property TimeToLive As TimeSpan

Property Value

System.TimeSpan

A System.TimeSpan representing the time to live of the health report.

Exceptions

System.ArgumentException

The specified value was invalid. Please provide a duration that is larger than 0.

Remarks

When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite.

When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true or evaluated at error, if RemoveWhenExpired is false.

Applies to