ClusterHealthPolicy.xml

<Type Name="ClusterHealthPolicy" FullName="Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy">
  <TypeSignature Language="C#" Value="public class ClusterHealthPolicy" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClusterHealthPolicy extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy" />
  <TypeSignature Language="VB.NET" Value="Public Class ClusterHealthPolicy" />
  <TypeSignature Language="F#" Value="type ClusterHealthPolicy = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
             Defines a health policy used to evaluate the health of the cluster or
             of a cluster node.
            
             </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClusterHealthPolicy ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the ClusterHealthPolicy class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClusterHealthPolicy (int? maxPercentUnhealthyNodes = default, int? maxPercentUnhealthyApplications = default, System.Collections.Generic.IDictionary&lt;string,Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; applicationHealthPolicies = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1&lt;int32&gt; maxPercentUnhealthyNodes, valuetype System.Nullable`1&lt;int32&gt; maxPercentUnhealthyApplications, class System.Collections.Generic.IDictionary`2&lt;string, class Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; applicationHealthPolicies) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.#ctor(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IDictionary{System.String,Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional maxPercentUnhealthyNodes As Nullable(Of Integer) = Nothing, Optional maxPercentUnhealthyApplications As Nullable(Of Integer) = Nothing, Optional applicationHealthPolicies As IDictionary(Of String, ApplicationHealthPolicy) = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy : Nullable&lt;int&gt; * Nullable&lt;int&gt; * System.Collections.Generic.IDictionary&lt;string, Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; -&gt; Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy" Usage="new Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy (maxPercentUnhealthyNodes, maxPercentUnhealthyApplications, applicationHealthPolicies)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="maxPercentUnhealthyNodes" Type="System.Nullable&lt;System.Int32&gt;" />
        <Parameter Name="maxPercentUnhealthyApplications" Type="System.Nullable&lt;System.Int32&gt;" />
        <Parameter Name="applicationHealthPolicies" Type="System.Collections.Generic.IDictionary&lt;System.String,Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt;" />
      </Parameters>
      <Docs>
        <param name="maxPercentUnhealthyNodes">The maximum allowed
             percentage of unhealthy nodes before reporting an error. For
             example, to allow 10% of nodes to be unhealthy, this value would be
             10.
            
             The percentage represents the maximum tolerated percentage of nodes
             that can be unhealthy before the cluster is considered in error.
             If the percentage is respected but there is at least one unhealthy
             node, the health is evaluated as Warning.
             The percentage is calculated by dividing the number of unhealthy
             nodes over the total number of nodes in the cluster.
             The computation rounds up to tolerate one failure on small numbers
             of nodes. Default percentage is zero.
            
             In large clusters, some nodes will always be down or out for
             repairs, so this percentage should be configured to tolerate that.
             </param>
        <param name="maxPercentUnhealthyApplications">The maximum allowed
             percentage of unhealthy applications before reporting an error. For
             example, to allow 10% of applications to be unhealthy, this value
             would be 10.
            
             The percentage represents the maximum tolerated percentage of
             applications that can be unhealthy before the cluster is considered
             in error.
             If the percentage is respected but there is at least one unhealthy
             application, the health is evaluated as Warning.
             This is calculated by dividing the number of unhealthy applications
             over the total number of application instances in the cluster,
             excluding applications of application types that are included in
             the ApplicationTypeHealthPolicyMap.
             The computation rounds up to tolerate one failure on small numbers
             of applications. Default percentage is zero.
             </param>
        <param name="applicationHealthPolicies">Defines the application
             health policy map used to evaluate the health of an application or
             one of its children entities.</param>
        <summary>
             Initializes a new instance of the ClusterHealthPolicy class.
             </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplicationHealthPolicies">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; ApplicationHealthPolicies { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, class Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; ApplicationHealthPolicies" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.ApplicationHealthPolicies" />
      <MemberSignature Language="VB.NET" Value="Public Property ApplicationHealthPolicies As IDictionary(Of String, ApplicationHealthPolicy)" />
      <MemberSignature Language="F#" Value="member this.ApplicationHealthPolicies : System.Collections.Generic.IDictionary&lt;string, Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt; with get, set" Usage="Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.ApplicationHealthPolicies" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="applicationHealthPolicies")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="applicationHealthPolicies")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,Microsoft.Azure.Management.ServiceFabric.Models.ApplicationHealthPolicy&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets defines the application health policy map used to
            evaluate the health of an application or one of its children
            entities.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MaxPercentUnhealthyApplications">
      <MemberSignature Language="C#" Value="public int? MaxPercentUnhealthyApplications { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MaxPercentUnhealthyApplications" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.MaxPercentUnhealthyApplications" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxPercentUnhealthyApplications As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MaxPercentUnhealthyApplications : Nullable&lt;int&gt; with get, set" Usage="Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.MaxPercentUnhealthyApplications" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxPercentUnhealthyApplications")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="maxPercentUnhealthyApplications")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
             Gets or sets the maximum allowed percentage of unhealthy
             applications before reporting an error. For example, to allow 10%
             of applications to be unhealthy, this value would be 10.
            
             The percentage represents the maximum tolerated percentage of
             applications that can be unhealthy before the cluster is considered
             in error.
             If the percentage is respected but there is at least one unhealthy
             application, the health is evaluated as Warning.
             This is calculated by dividing the number of unhealthy applications
             over the total number of application instances in the cluster,
             excluding applications of application types that are included in
             the ApplicationTypeHealthPolicyMap.
             The computation rounds up to tolerate one failure on small numbers
             of applications. Default percentage is zero.
            
             </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MaxPercentUnhealthyNodes">
      <MemberSignature Language="C#" Value="public int? MaxPercentUnhealthyNodes { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; MaxPercentUnhealthyNodes" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.MaxPercentUnhealthyNodes" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxPercentUnhealthyNodes As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.MaxPercentUnhealthyNodes : Nullable&lt;int&gt; with get, set" Usage="Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.MaxPercentUnhealthyNodes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxPercentUnhealthyNodes")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="maxPercentUnhealthyNodes")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
             Gets or sets the maximum allowed percentage of unhealthy nodes
             before reporting an error. For example, to allow 10% of nodes to be
             unhealthy, this value would be 10.
            
             The percentage represents the maximum tolerated percentage of nodes
             that can be unhealthy before the cluster is considered in error.
             If the percentage is respected but there is at least one unhealthy
             node, the health is evaluated as Warning.
             The percentage is calculated by dividing the number of unhealthy
             nodes over the total number of nodes in the cluster.
             The computation rounds up to tolerate one failure on small numbers
             of nodes. Default percentage is zero.
            
             In large clusters, some nodes will always be down or out for
             repairs, so this percentage should be configured to tolerate that.
            
             </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public virtual void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ServiceFabric.Models.ClusterHealthPolicy.Validate" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
      <MemberSignature Language="F#" Value="abstract member Validate : unit -&gt; unit&#xA;override this.Validate : unit -&gt; unit" Usage="clusterHealthPolicy.Validate " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Validate the object.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Rest.ValidationException">
            Thrown if validation fails
            </exception>
      </Docs>
    </Member>
  </Members>
</Type>