Healthcheck Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the health check configuration for a container.
[YamlDotNet.Serialization.YamlSerializable]
public sealed class Healthcheck
[<YamlDotNet.Serialization.YamlSerializable>]
type Healthcheck = class
Public NotInheritable Class Healthcheck
- Inheritance
-
Healthcheck
- Attributes
-
YamlDotNet.Serialization.YamlSerializableAttribute
Constructors
| Healthcheck() |
Properties
| Interval |
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. |
| Retries |
Specifies the number of retries to be attempted for the health check before marking it as failed. |
| StartPeriod |
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. |
| Test |
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. |
| Timeout |
Specifies the maximum duration to wait for a healthcheck to complete. |