application_healths

Creates, updates, deletes, gets or lists an application_healths resource.

Overview

Name	`application_healths`
Type	Resource
Id	`azure.service_fabric_dataplane.application_healths`

Fields

The following fields are returned by SELECT queries:

get_application_health

Name	Datatype	Description
`AggregatedHealthState`	`string`
`DeployedApplicationHealthStates`	`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`
`ServiceHealthStates`	`array`
`UnhealthyEvaluations`	`array`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_application_health`	`select`	`application_id`, `endpoint`	`EventsHealthStateFilter`, `DeployedApplicationsHealthStateFilter`, `ServicesHealthStateFilter`, `ExcludeHealthStatistics`, `timeout`	Gets the health of the service fabric application. Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.

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 "myapp~~app1" in 6.0+ and "myapp/app1" in previous versions.
`endpoint`	`string`	The service endpoint host (no scheme). (default: )
`DeployedApplicationsHealthStateFilter`	`integer`	Allows filtering of the deployed applications health state objects returned in the result of 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 applications that match the filter will be returned. All deployed applications 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 bitwise 'OR' operator. For example, if the provided value is 6 then health state of deployed applications 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.
`ServicesHealthStateFilter`	`integer`	Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services 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 bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be 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_application_health

Gets the health of the service fabric application. Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.

SELECT
AggregatedHealthState,
DeployedApplicationHealthStates,
HealthEvents,
HealthStatistics,
Name,
ServiceHealthStates,
UnhealthyEvaluations
FROM azure.service_fabric_dataplane.application_healths
WHERE application_id = '{{ application_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND EventsHealthStateFilter = '{{ EventsHealthStateFilter }}'
AND DeployedApplicationsHealthStateFilter = '{{ DeployedApplicationsHealthStateFilter }}'
AND ServicesHealthStateFilter = '{{ ServicesHealthStateFilter }}'
AND ExcludeHealthStatistics = '{{ ExcludeHealthStatistics }}'
AND timeout = '{{ timeout }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Overview

Fields

Methods

Parameters

`SELECT` examples