ContainerAppProbe Class

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Inheritance

azure.mgmt.appcontainers._serialization.Model

ContainerAppProbe

Constructor

ContainerAppProbe(*, failure_threshold: int | None = None, http_get: _models.ContainerAppProbeHttpGet | None = None, initial_delay_seconds: int | None = None, period_seconds: int | None = None, success_threshold: int | None = None, tcp_socket: _models.ContainerAppProbeTcpSocket | None = None, termination_grace_period_seconds: int | None = None, timeout_seconds: int | None = None, type: str | _models.Type | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
failure_threshold	int Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
http_get	ContainerAppProbeHttpGet HTTPGet specifies the http request to perform.
initial_delay_seconds	int Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
period_seconds	int How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
success_threshold	int Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
tcp_socket	ContainerAppProbeTcpSocket TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
termination_grace_period_seconds	int Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).
timeout_seconds	int Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
type	str or Type The type of probe. Known values are: "Liveness", "Readiness", and "Startup".

Variables

Name	Description
failure_threshold	int Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
http_get	ContainerAppProbeHttpGet HTTPGet specifies the http request to perform.
initial_delay_seconds	int Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
period_seconds	int How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
success_threshold	int Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
tcp_socket	ContainerAppProbeTcpSocket TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
termination_grace_period_seconds	int Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).
timeout_seconds	int Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
type	str or Type The type of probe. Known values are: "Liveness", "Readiness", and "Startup".