AppInstanceProbe Class

Definition

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

public class AppInstanceProbe : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppPlatform.Models.AppInstanceProbe>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppPlatform.Models.AppInstanceProbe>
public class AppInstanceProbe
type AppInstanceProbe = class
    interface IJsonModel<AppInstanceProbe>
    interface IPersistableModel<AppInstanceProbe>
type AppInstanceProbe = class
Public Class AppInstanceProbe
Implements IJsonModel(Of AppInstanceProbe), IPersistableModel(Of AppInstanceProbe)
Public Class AppInstanceProbe
Inheritance
AppInstanceProbe
Implements

Constructors

AppInstanceProbe(Boolean)

Initializes a new instance of AppInstanceProbe.

Properties

FailureThreshold

Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.

InitialDelayInSeconds

Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

IsProbeDisabled

Indicate whether the probe is disabled.

PeriodInSeconds

How often (in seconds) to perform the probe. Minimum value is 1.

ProbeAction

The action of the probe. Please note AppInstanceProbeAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AppInstanceExecAction, AppInstanceHttpGetAction and AppInstanceTcpSocketAction.

SuccessThreshold

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.

TimeoutInSeconds

Number of seconds after which the probe times out. Minimum value is 1.

Explicit Interface Implementations

IJsonModel<AppInstanceProbe>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AppInstanceProbe>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AppInstanceProbe>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AppInstanceProbe>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AppInstanceProbe>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to