ContainerAppProbe interface

Package:

@azure/arm-appcontainers

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

Properties

failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
httpGet	HTTPGet specifies the http request to perform.
initialDelaySeconds	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
successThreshold	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.
tcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
terminationGracePeriodSeconds	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)
timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
type	The type of probe.

Property Details

failureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.

failureThreshold?: number

Property Value

number

httpGet

HTTPGet specifies the http request to perform.

httpGet?: ContainerAppProbeHttpGet

Property Value

ContainerAppProbeHttpGet

initialDelaySeconds

Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.

initialDelaySeconds?: number

Property Value

number

periodSeconds

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.

periodSeconds?: number

Property Value

number

successThreshold

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.

successThreshold?: number

Property Value

number

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

tcpSocket?: ContainerAppProbeTcpSocket

Property Value

ContainerAppProbeTcpSocket

terminationGracePeriodSeconds

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)

terminationGracePeriodSeconds?: number

Property Value

number

timeoutSeconds

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.

timeoutSeconds?: number

Property Value

number

type

The type of probe.

type?: string

Property Value

string