FabricClient.HealthClient.ReportHealth Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

ReportHealth(HealthReport)	Reports health on a Service Fabric entity.
ReportHealth(HealthReport, HealthReportSendOptions)	Reports health on a Service Fabric entity and passes send options to control how the report is sent.

ReportHealth(HealthReport)

Reports health on a Service Fabric entity.

C#

public void ReportHealth(System.Fabric.Health.HealthReport healthReport);

Parameters

healthReport

HealthReport

The HealthReport to submit.

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.

ArgumentNullException

Returned when a null reference is passed to a method that does not accept it as a valid argument.

FabricException

Caused by one of the following:

FabricHealthStaleReport.

FabricHealthMaxReportsReached.

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

UnauthorizedAccessException

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

When a cluster is secured, the health client needs administrator permission to be able to send the reports. Read more about connecting to a cluster using the FabricClient APIs.

For more information about health reporting, see Service Fabric health monitoring.

ReportHealth(HealthReport, HealthReportSendOptions)

Reports health on a Service Fabric entity and passes send options to control how the report is sent.

C#

public void ReportHealth(System.Fabric.Health.HealthReport healthReport, System.Fabric.Health.HealthReportSendOptions sendOptions);

Parameters

healthReport

HealthReport

The HealthReport to submit.

sendOptions

HealthReportSendOptions

The HealthReportSendOptions that controls how the report is sent.

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.

ArgumentNullException

Returned when a null reference is passed to a method that does not accept it as a valid argument.

FabricException

Caused by one of the following:

FabricHealthStaleReport.

FabricHealthMaxReportsReached.

InvalidCredentialType.

InvalidX509FindType.

InvalidX509StoreLocation.

InvalidX509StoreName.

InvalidX509Thumbprint.

InvalidProtectionLevel.

InvalidX509Store.

InvalidSubjectName.

InvalidAllowedCommonNameList.

UnauthorizedAccessException

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

When a cluster is secured, the health client needs administrator permission to be able to send the reports. Read more about connecting to a cluster using the FabricClient APIs.

For more information about health reporting, see Service Fabric health monitoring.