ArmAppContainersModelFactory.SessionProbe Method
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.
Session probe configuration.
public static Azure.ResourceManager.AppContainers.Models.SessionProbe SessionProbe(Azure.ResourceManager.AppContainers.Models.SessionProbeType? type = default, Azure.ResourceManager.AppContainers.Models.SessionProbeHttpGet httpGet = default, Azure.ResourceManager.AppContainers.Models.SessionProbeTcpSocket tcpSocket = default, int? failureThreshold = default, int? initialDelaySeconds = default, int? periodSeconds = default, int? successThreshold = default, long? terminationGracePeriodSeconds = default, int? timeoutSeconds = default);static member SessionProbe : Nullable<Azure.ResourceManager.AppContainers.Models.SessionProbeType> * Azure.ResourceManager.AppContainers.Models.SessionProbeHttpGet * Azure.ResourceManager.AppContainers.Models.SessionProbeTcpSocket * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int64> * Nullable<int> -> Azure.ResourceManager.AppContainers.Models.SessionProbePublic Shared Function SessionProbe (Optional type As Nullable(Of SessionProbeType) = Nothing, Optional httpGet As SessionProbeHttpGet = Nothing, Optional tcpSocket As SessionProbeTcpSocket = Nothing, Optional failureThreshold As Nullable(Of Integer) = Nothing, Optional initialDelaySeconds As Nullable(Of Integer) = Nothing, Optional periodSeconds As Nullable(Of Integer) = Nothing, Optional successThreshold As Nullable(Of Integer) = Nothing, Optional terminationGracePeriodSeconds As Nullable(Of Long) = Nothing, Optional timeoutSeconds As Nullable(Of Integer) = Nothing) As SessionProbeParameters
- type
- Nullable<SessionProbeType>
Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).
- httpGet
- SessionProbeHttpGet
HTTPGet specifies the http request to perform.
- tcpSocket
- SessionProbeTcpSocket
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
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.
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).
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
Returns
A new SessionProbe instance for mocking.
