ExternalHealthPolicy Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies the external health policy for the virtual machine scale set.
public class ExternalHealthPolicy : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.Models.ExternalHealthPolicy>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.Models.ExternalHealthPolicy>
type ExternalHealthPolicy = class
interface IJsonModel<ExternalHealthPolicy>
interface IPersistableModel<ExternalHealthPolicy>
Public Class ExternalHealthPolicy
Implements IJsonModel(Of ExternalHealthPolicy), IPersistableModel(Of ExternalHealthPolicy)
- Inheritance
-
ExternalHealthPolicy
- Implements
Constructors
| Name | Description |
|---|---|
| ExternalHealthPolicy() |
Initializes a new instance of ExternalHealthPolicy. |
Properties
| Name | Description |
|---|---|
| Enabled |
If true, external health is enabled for this scale set. Cannot be set to true on instances where another health monitoring source is active (ApplicationHealth extension or SLB). Defaults to false. |
| ExpiryDuration |
Defines how long the health status set by External Health API will last on the VM. If a signal is not received/updated within this time, the VM Health will be marked as "unknown". Uses the ISO 8601 format. Minimum: 5 minutes (PT5M), Maximum: 3 hours (PT3H). |
| GracePeriod |
Grace period for newly created VMs or when the External Health policy is first applied on VMSS. Uses the ISO 8601 format. Minimum: 5 minutes (PT5M), Maximum: 4 hours (PT4H). |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ExternalHealthPolicy>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ExternalHealthPolicy>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ExternalHealthPolicy>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ExternalHealthPolicy>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ExternalHealthPolicy>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |