Edit

Share via

New-AzContainerAppProbeObject

  • Reference
Module:
Az.App

Create an in-memory object for ContainerAppProbe.

Syntax

New-AzContainerAppProbeObject
   [-FailureThreshold <Int32>]
   [-HttpGetHost <String>]
   [-HttpGetHttpHeader <IContainerAppProbeHttpGetHttpHeadersItem[]>]
   [-HttpGetPath <String>]
   [-HttpGetPort <Int32>]
   [-HttpGetScheme <String>]
   [-InitialDelaySecond <Int32>]
   [-PeriodSecond <Int32>]
   [-SuccessThreshold <Int32>]
   [-TcpSocketHost <String>]
   [-TcpSocketPort <Int32>]
   [-TerminationGracePeriodSecond <Int64>]
   [-TimeoutSecond <Int32>]
   [-Type <String>]
   [<CommonParameters>]

Description

Create an in-memory object for ContainerAppProbe.

Examples

Example 1: Create an in-memory object for ContainerAppProbe.

$probeHttpGetHttpHeader = New-AzContainerAppProbeHeaderObject -Name "Custom-Header" -Value "Awesome"

New-AzContainerAppProbeObject -Type "Liveness" -HttpGetPath "/health" -HttpGetPort 8080 -InitialDelaySecond 3 -PeriodSecond 3 -HttpGetHttpHeader $probeHttpGetHttpHeader

FailureThreshold InitialDelaySecond PeriodSecond SuccessThreshold TerminationGracePeriodSecond TimeoutSecond
---------------- ------------------ ------------ ---------------- ---------------------------- -------------
                 3                  3

Create an in-memory object for ContainerAppProbe.

Parameters

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpGetHost

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpGetHttpHeader

Custom headers to set in the request. HTTP allows repeated headers.

Type:IContainerAppProbeHttpGetHttpHeadersItem[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpGetPath

Path to access on the HTTP server.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpGetScheme

Scheme to use for connecting to the host. Defaults to HTTP.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InitialDelaySecond

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PeriodSecond

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TcpSocketHost

Optional: Host name to connect to, defaults to the pod IP.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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).

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutSecond

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Type

The type of probe.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

ContainerAppProbe