replica_health_using_policies

Creates, updates, deletes, gets or lists a replica_health_using_policies resource.

Overview

Name	replica_health_using_policies
Type	Resource
Id	azure.service_fabric_dataplane.replica_health_using_policies

Fields

The following fields are returned by SELECT queries:

get_replica_health_using_policy

Name	Datatype	Description
AggregatedHealthState	string
HealthEvents	array
HealthStatistics	object	The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.
PartitionId	string
ServiceKind	string
UnhealthyEvaluations	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_replica_health_using_policy	select	replica_id, partition_id, endpoint	EventsHealthStateFilter, timeout	Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy. Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.

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.
replica_id	string	The identifier of the replica.
EventsHealthStateFilter	integer	Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
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.

SELECT examples

get_replica_health_using_policy

Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy. Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.

SELECT
AggregatedHealthState,
HealthEvents,
HealthStatistics,
PartitionId,
ServiceKind,
UnhealthyEvaluations
FROM azure.service_fabric_dataplane.replica_health_using_policies
WHERE replica_id = '{{ replica_id }}' -- required
AND partition_id = '{{ partition_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND EventsHealthStateFilter = '{{ EventsHealthStateFilter }}'
AND timeout = '{{ timeout }}'
;