Share via

Get-ServiceFabricServiceHealth

Module:
ServiceFabric Module

Gets the health of a Service Fabric service.

Syntax

Default (Default) 

Get-ServiceFabricServiceHealth
    [-ServiceName] <Uri>
    [-ConsiderWarningAsError <Boolean>]
    [-MaxPercentUnhealthyPartitionsPerService <Byte>]
    [-MaxPercentUnhealthyReplicasPerPartition <Byte>]
    [-EventsHealthStateFilter <Int64>]
    [-EventsFilter <HealthStateFilter>]
    [-PartitionsHealthStateFilter <Int64>]
    [-PartitionsFilter <HealthStateFilter>]
    [-ExcludeHealthStatistics]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Get-ServiceFabricServiceHealth cmdlet gets the health of a Service Fabric service. If you specify a service that does not exist in the health store, this cmdlet returns an exception.

Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

Examples

Example 1: Query the health of a service

PS C:\> Get-ServiceFabricServiceHealth -ServiceName fabric:/myapp/persistenttodolist/svc1

This command gets the health of the specified service.

Example 2: Get the health of a service using custom health policy and return filters

PS C:\> Get-ServiceFabricServiceHealth -ServiceName fabric:/myapp/persistenttodolist/svc1 -ConsiderWarningAsError $True -EventsFilter Error -PartitionsFilter 'Warning,Error'

This command queries the health of the specified service. It provides values for health policy. It uses filters to return only Error events, and children with Error or Warning health states.

Example 3: Query the health of a service and exclude the health statistics

PS C:\> Get-ServiceFabricServiceHealth -ServiceName fabric:/myapp/persistenttodolist/svc1 -ExcludeHealthStatistics

This command gets the health of the specified service. The returned service health doesn't include the service health statistics.

Parameters

-ConsiderWarningAsError

Indicates whether to treat a warning health report as an error during health evaluation.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EventsFilter

Specifies the filter for the collection of HealthEvent reported on the entity based on health state. The value can be obtained from members or bitwise operations on members of HealthStateFilter. 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.

Parameter properties

Type:HealthStateFilter
Default value:None
Accepted values:Default, None, Ok, Warning, Error, All
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EventsHealthStateFilter

This parameter has been deprecated. Specify the EventsFilter parameter instead.

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExcludeHealthStatistics

Indicates whether the health statistics should be included in the query result. If specified, the health statistics are not returned as part of the query result. Otherwise, the query result includes the service health statistics, which contain information about how many partitions and replicas of this service are in Ok, Warning, and Error states.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxPercentUnhealthyPartitionsPerService

Specifies the maximum tolerated percentage of unhealthy partitions in a service. If there are more partitions with a health state error than tolerated, the health state of the service is error.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxPercentUnhealthyReplicasPerPartition

Specifies the maximum tolerated percentage of unhealthy partition replicas. If there are more replicas with a health state error than tolerated, the health state of the partition is error.

Parameter properties

Type:Byte
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PartitionsFilter

Specifies the filter for PartitionHealthState children based on health state. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only children that match the filter are returned. All children are used to evaluate the entity aggregated health state. If not specified, all entries are returned.

Parameter properties

Type:HealthStateFilter
Default value:None
Accepted values:Default, None, Ok, Warning, Error, All
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PartitionsHealthStateFilter

This parameter has been deprecated. Specify the PartitionsFilter parameter instead.

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceName

Specifies the URI of a Service Fabric service.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Uri

Outputs

System.Object