ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithReadinessProbe<ParentT> Interface

Type Parameters

ParentT

the stage of the parent definition to return to after attaching this definition

public static interface ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithReadinessProbe<ParentT>

The stage of the container instance definition allowing to specify readiness probe. Azure Container Instances supports readiness probes to include configurations so that your container can't be accessed under certain conditions.

Method Summary

Modifier and Type Method and Description
abstract WithContainerInstanceAttach<ParentT> withReadinessProbe(ContainerProbe readinessProbe)

Specifies the container's readiness probe.

abstract WithContainerInstanceAttach<ParentT> withReadinessProbeExecutionCommand(List<String> command, int probePeriodSeconds)

Specifies the container's readiness probe to execute a given command at a given interval.

abstract WithContainerInstanceAttach<ParentT> withReadinessProbeExecutionCommand(List<String> command, int probePeriodSeconds, int failureThreshold)

Specifies the container's readiness probe to execute a given command at a given interval.

abstract WithContainerInstanceAttach<ParentT> withReadinessProbeHttpGet(String path, int port, int probePeriodSeconds)

Specifies the container's readiness probe to perform an Http Get at a given interval.

abstract WithContainerInstanceAttach<ParentT> withReadinessProbeHttpGet(String path, int port, int probePeriodSeconds, int failureThreshold)

Specifies the container's readiness probe to perform an Http Get at a given interval.

Method Details

withReadinessProbe

public abstract ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithContainerInstanceAttach<ParentT> withReadinessProbe(ContainerProbe readinessProbe)

Specifies the container's readiness probe.

Parameters:

readinessProbe - the readiness probe

Returns:

the next stage of the definition

withReadinessProbeExecutionCommand

public abstract ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithContainerInstanceAttach<ParentT> withReadinessProbeExecutionCommand(List<String> command, int probePeriodSeconds)

Specifies the container's readiness probe to execute a given command at a given interval.

If the probe command execution fails, the container will continue to run but can't be accessed.

Only 1 readiness probe can be set for a given container.

Parameters:

command - the command for the probe to execute
probePeriodSeconds - the interval at which the command executes

Returns:

the next stage of the definition

withReadinessProbeExecutionCommand

public abstract ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithContainerInstanceAttach<ParentT> withReadinessProbeExecutionCommand(List<String> command, int probePeriodSeconds, int failureThreshold)

Specifies the container's readiness probe to execute a given command at a given interval.

After the probe command execution failure reaches the given threshold, the container will continue to run but can't be accessed.

Only 1 readiness probe can be set for a given container.

Parameters:

command - the command for the probe to execute
probePeriodSeconds - the interval at which the command executes
failureThreshold - the consecutive probe failure count before the container becomes inaccessible

Returns:

the next stage of the definition

withReadinessProbeHttpGet

public abstract ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithContainerInstanceAttach<ParentT> withReadinessProbeHttpGet(String path, int port, int probePeriodSeconds)

Specifies the container's readiness probe to perform an Http Get at a given interval.

If the probe HTTP GET operation fails with non-200 response, the container will continue to run but can't be accessed.

Only 1 readiness probe can be set for a given container.

Parameters:

path - the path to perform the Http Get, starts with "/"
port - the port number to probe
probePeriodSeconds - the interval at which the Http Get performs

Returns:

the next stage of the definition

withReadinessProbeHttpGet

public abstract ContainerGroup.DefinitionStages.ContainerInstanceDefinitionStages.WithContainerInstanceAttach<ParentT> withReadinessProbeHttpGet(String path, int port, int probePeriodSeconds, int failureThreshold)

Specifies the container's readiness probe to perform an Http Get at a given interval.

After the probe HTTP GET failure with non-200 response reaches the given threshold, the container will continue to run but can't be accessed.

Only 1 readiness probe can be set for a given container.

Parameters:

path - the path to perform the Http Get, starts with "/"
port - the port number to probe
probePeriodSeconds - the interval at which the Http Get performs
failureThreshold - the consecutive probe failure count before the container becomes inaccessible

Returns:

the next stage of the definition

Applies to