FabricClient.HealthClient.ReportHealth Method
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.
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.
public void ReportHealth (System.Fabric.Health.HealthReport healthReport);member this.ReportHealth : System.Fabric.Health.HealthReport -> unitPublic Sub ReportHealth (healthReport As HealthReport)Parameters
- healthReport
- HealthReport
The HealthReport to submit.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Returned when a null reference is passed to a method that does not accept it as a valid argument.
Caused by one of the following:
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.
Applies to
ReportHealth(HealthReport, HealthReportSendOptions)
Reports health on a Service Fabric entity and passes send options to control how the report is sent.
public void ReportHealth (System.Fabric.Health.HealthReport healthReport, System.Fabric.Health.HealthReportSendOptions sendOptions);member this.ReportHealth : System.Fabric.Health.HealthReport * System.Fabric.Health.HealthReportSendOptions -> unitPublic Sub ReportHealth (healthReport As HealthReport, sendOptions As HealthReportSendOptions)Parameters
- healthReport
- HealthReport
The HealthReport to submit.
- sendOptions
- HealthReportSendOptions
The HealthReportSendOptions that controls how the report is sent.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Returned when a null reference is passed to a method that does not accept it as a valid argument.
Caused by one of the following:
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.