deployed_service_package_health_using_policies
Creates, updates, deletes, gets or lists a deployed_service_package_health_using_policies resource.
Overview
| Name | deployed_service_package_health_using_policies |
| Type | Resource |
| Id | azure.service_fabric_dataplane.deployed_service_package_health_using_policies |
Fields
The following fields are returned by SELECT queries:
- get_deployed_service_package_health_using_policy
| Name | Datatype | Description |
|---|---|---|
AggregatedHealthState | string | |
ApplicationName | 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. |
NodeName | string | |
ServiceManifestName | string | |
UnhealthyEvaluations | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_deployed_service_package_health_using_policy | select | application_id, service_package_name, node_name, endpoint | EventsHealthStateFilter, timeout | Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on 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 deployed service package. |
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 " |
endpoint | string | The service endpoint host (no scheme). (default: ) |
node_name | string | The name of the node. |
service_package_name | string | The name of the service package. |
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_deployed_service_package_health_using_policy
Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on 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 deployed service package.
SELECT
AggregatedHealthState,
ApplicationName,
HealthEvents,
HealthStatistics,
NodeName,
ServiceManifestName,
UnhealthyEvaluations
FROM azure.service_fabric_dataplane.deployed_service_package_health_using_policies
WHERE application_id = '{{ application_id }}' -- required
AND service_package_name = '{{ service_package_name }}' -- required
AND node_name = '{{ node_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND EventsHealthStateFilter = '{{ EventsHealthStateFilter }}'
AND timeout = '{{ timeout }}'
;