report_partition_healths
Creates, updates, deletes, gets or lists a report_partition_healths resource.
Overview
| Name | report_partition_healths |
| Type | Resource |
| Id | azure.service_fabric_dataplane.report_partition_healths |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
report_partition_health | exec | partition_id, endpoint, SourceId, Property, HealthState | Immediate, timeout | Sends a health report on the Service Fabric partition. Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Partition, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
partition_id | string | The identity of the partition. |
Immediate | boolean | A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. |
timeout | integer (int64) | The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. |
Lifecycle Methods
- report_partition_health
Sends a health report on the Service Fabric partition. Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Partition, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.
EXEC azure.service_fabric_dataplane.report_partition_healths.report_partition_health
@partition_id='{{ partition_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@Immediate={{ Immediate }},
@timeout='{{ timeout }}'
@@json=
'{
"SourceId": "{{ SourceId }}",
"Property": "{{ Property }}",
"HealthState": "{{ HealthState }}",
"TimeToLiveInMilliSeconds": "{{ TimeToLiveInMilliSeconds }}",
"Description": "{{ Description }}",
"SequenceNumber": "{{ SequenceNumber }}",
"RemoveWhenExpired": {{ RemoveWhenExpired }},
"HealthReportId": "{{ HealthReportId }}"
}'
;