HealthCheckOptions.ResultStatusCodes Property

Reference

Definition

Namespace:: Microsoft.AspNetCore.Diagnostics.HealthChecks

Assembly:: Microsoft.AspNetCore.Diagnostics.HealthChecks.dll

Package:: Microsoft.AspNetCore.Diagnostics.HealthChecks v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: HealthCheckOptions.cs

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.

Gets or sets a dictionary mapping the HealthStatus to an HTTP status code applied to the response. This property can be used to configure the status codes returned for each status.

public:
 property System::Collections::Generic::IDictionary<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus, int> ^ ResultStatusCodes { System::Collections::Generic::IDictionary<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus, int> ^ get(); };

public:
 property System::Collections::Generic::IDictionary<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus, int> ^ ResultStatusCodes { System::Collections::Generic::IDictionary<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus, int> ^ get(); void set(System::Collections::Generic::IDictionary<Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus, int> ^ value); };

public System.Collections.Generic.IDictionary<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,int> ResultStatusCodes { get; }

public System.Collections.Generic.IDictionary<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,int> ResultStatusCodes { get; set; }

member this.ResultStatusCodes : System.Collections.Generic.IDictionary<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus, int>

member this.ResultStatusCodes : System.Collections.Generic.IDictionary<Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus, int> with get, set

Public ReadOnly Property ResultStatusCodes As IDictionary(Of HealthStatus, Integer)

Public Property ResultStatusCodes As IDictionary(Of HealthStatus, Integer)

Property Value

IDictionary<HealthStatus,Int32>

Exceptions

InvalidOperationException

Thrown if at least one HealthStatus is missing when setting this property.

Remarks

Setting this property to null resets the mapping to its default value which maps Healthy to 200 (OK), Degraded to 200 (OK) and Unhealthy to 503 (Service Unavailable).

Applies to