ArmAppContainersModelFactory.ContainerAppProbe Method

Definition

Namespace:

Azure.ResourceManager.AppContainers.Models

Assembly:

Azure.ResourceManager.AppContainers.dll

Package:

Azure.ResourceManager.AppContainers v1.6.0

Source:

ArmAppContainersModelFactory.cs

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

public static Azure.ResourceManager.AppContainers.Models.ContainerAppProbe ContainerAppProbe(int? failureThreshold = default, Azure.ResourceManager.AppContainers.Models.ContainerAppHttpRequestInfo httpGet = default, int? initialDelaySeconds = default, int? periodSeconds = default, int? successThreshold = default, Azure.ResourceManager.AppContainers.Models.ContainerAppTcpSocketRequestInfo tcpSocket = default, long? terminationGracePeriodSeconds = default, int? timeoutSeconds = default, Azure.ResourceManager.AppContainers.Models.ContainerAppProbeType? probeType = default);

static member ContainerAppProbe : Nullable<int> * Azure.ResourceManager.AppContainers.Models.ContainerAppHttpRequestInfo * Nullable<int> * Nullable<int> * Nullable<int> * Azure.ResourceManager.AppContainers.Models.ContainerAppTcpSocketRequestInfo * Nullable<int64> * Nullable<int> * Nullable<Azure.ResourceManager.AppContainers.Models.ContainerAppProbeType> -> Azure.ResourceManager.AppContainers.Models.ContainerAppProbe

Public Shared Function ContainerAppProbe (Optional failureThreshold As Nullable(Of Integer) = Nothing, Optional httpGet As ContainerAppHttpRequestInfo = Nothing, Optional initialDelaySeconds As Nullable(Of Integer) = Nothing, Optional periodSeconds As Nullable(Of Integer) = Nothing, Optional successThreshold As Nullable(Of Integer) = Nothing, Optional tcpSocket As ContainerAppTcpSocketRequestInfo = Nothing, Optional terminationGracePeriodSeconds As Nullable(Of Long) = Nothing, Optional timeoutSeconds As Nullable(Of Integer) = Nothing, Optional probeType As Nullable(Of ContainerAppProbeType) = Nothing) As ContainerAppProbe

Parameters

failureThreshold

Nullable<Int32>

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

ContainerAppHttpRequestInfo

HTTPGet specifies the http request to perform.

initialDelaySeconds

Nullable<Int32>

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

periodSeconds

Nullable<Int32>

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

successThreshold

Nullable<Int32>

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

ContainerAppTcpSocketRequestInfo

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

terminationGracePeriodSeconds

Nullable<Int64>

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

Nullable<Int32>

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

probeType

Nullable<ContainerAppProbeType>

The type of probe.

Returns

ContainerAppProbe

A new ContainerAppProbe instance for mocking.