Skip to content
Docs Try Aspire

Healthcheck Properties

Class Properties 5 members
Represents the health check configuration for a container.
Specifies the duration between health check executions for a service. Accepts a string representation of the time interval in a supported format. Used to configure the frequency at which the health check is performed.
public string Interval { get; set; }
Retries Section titled Retries nullable int?
Specifies the number of retries to be attempted for the health check before marking it as failed.
public int? Retries { get; set; }
This property indicates how many times the system should retry the health check command if it fails before considering the health check unsuccessful. The value must be a non-negative integer or null if not specified.
StartPeriod Section titled StartPeriod string
Gets or sets the duration to wait after a container starts before attempting health checks. This property specifies the initial delay before the first health check is performed, which can be useful in cases where the application within the container requires some time to initialize before it can be properly checked for health status.
public string StartPeriod { get; set; }
Test Section titled Test List<string>
Represents the command or set of commands to be executed as part of the health check for a service node. This property is defined as a list of strings, where each string is a command or argument contributing to the health check operation.
public List<string> Test { get; set; }
Specifies the maximum duration to wait for a healthcheck to complete.
public string Timeout { get; set; }