ContainerAppProbe Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.App.Models

Assembly:

Az.App.private.dll

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.ContainerAppProbeTypeConverter))]
public class ContainerAppProbe : Microsoft.Azure.PowerShell.Cmdlets.App.Models.IContainerAppProbe

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.ContainerAppProbeTypeConverter))>]
type ContainerAppProbe = class
    interface IContainerAppProbe
    interface IJsonSerializable

Public Class ContainerAppProbe
Implements IContainerAppProbe

Inheritance

Object

ContainerAppProbe

Attributes

TypeConverterAttribute

Implements

IContainerAppProbe IJsonSerializable

Constructors

ContainerAppProbe()

Creates an new ContainerAppProbe instance.

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.
HttpGetHost	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
HttpGetHttpHeader	Custom headers to set in the request. HTTP allows repeated headers.
HttpGetPath	Path to access on the HTTP server.
HttpGetPort	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
HttpGetScheme	Scheme to use for connecting to the host. Defaults to HTTP.
InitialDelaySecond	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
PeriodSecond	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.
TcpSocketHost	Optional: Host name to connect to, defaults to the pod IP.
TcpSocketPort	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
TerminationGracePeriodSecond	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)
TimeoutSecond	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.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of ContainerAppProbe.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ContainerAppProbe.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.App.Models.IContainerAppProbe.
FromJsonString(String)	Creates a new instance of ContainerAppProbe, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ContainerAppProbe into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()