deployed_application_healths

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

Overview

Name	deployed_application_healths
Type	Resource
Id	azure.service_fabric_dataplane.deployed_application_healths

Fields

The following fields are returned by SELECT queries:

get_deployed_application_health

Name	Datatype	Description
AggregatedHealthState	string
DeployedServicePackageHealthStates	array
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.
Name	string
NodeName	string
UnhealthyEvaluations	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployed_application_health	select	application_id, node_name, endpoint	EventsHealthStateFilter, DeployedServicePackagesHealthStateFilter, ExcludeHealthStatistics, timeout	Gets the information about health of an application deployed on a Service Fabric node. Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.

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
application_id	string	The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myappapp1" in 6.0+ and "myapp/app1" in previous versions.
endpoint	string	The service endpoint host (no scheme). (default: )
node_name	string	The name of the node.
DeployedServicePackagesHealthStateFilter	integer	Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages 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.
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.
ExcludeHealthStatistics	boolean	Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
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_deployed_application_health

Gets the information about health of an application deployed on a Service Fabric node. Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.

SELECT
AggregatedHealthState,
DeployedServicePackageHealthStates,
HealthEvents,
HealthStatistics,
Name,
NodeName,
UnhealthyEvaluations
FROM azure.service_fabric_dataplane.deployed_application_healths
WHERE application_id = '{{ application_id }}' -- required
AND node_name = '{{ node_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND EventsHealthStateFilter = '{{ EventsHealthStateFilter }}'
AND DeployedServicePackagesHealthStateFilter = '{{ DeployedServicePackagesHealthStateFilter }}'
AND ExcludeHealthStatistics = '{{ ExcludeHealthStatistics }}'
AND timeout = '{{ timeout }}'
;