FabricClient.HealthClient.GetClusterHealthChunkAsync Method

Definition

Overloads

GetClusterHealthChunkAsync()

Gets the health of a Service Fabric cluster.

GetClusterHealthChunkAsync(ClusterHealthChunkQueryDescription)

Gets the health of a Service Fabric cluster, including cluster entities as requested in the query description.

GetClusterHealthChunkAsync(TimeSpan, CancellationToken)

Gets the health of a Service Fabric cluster.

GetClusterHealthChunkAsync(ClusterHealthChunkQueryDescription, TimeSpan, CancellationToken)

Gets the health of a Service Fabric cluster, including cluster entities as requested in the query description.

GetClusterHealthChunkAsync()

Gets the health of a Service Fabric cluster.

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk> GetClusterHealthChunkAsync ();
member this.GetClusterHealthChunkAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk>
Public Function GetClusterHealthChunkAsync () As Task(Of ClusterHealthChunk)

Returns

Task<ClusterHealthChunk>

The health chunk representing the cluster health.

Exceptions

Caused by one of the following:

FabricHealthEntityNotFound.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Caused by one of the following:

ServiceTooBusy is returned when the service is too busy to process the operation.

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

The cluster aggregated health state is computed based on all entities in the cluster. No children are included in the results, because no filters are specified.

Applies to

GetClusterHealthChunkAsync(ClusterHealthChunkQueryDescription)

Gets the health of a Service Fabric cluster, including cluster entities as requested in the query description.

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk> GetClusterHealthChunkAsync (System.Fabric.Description.ClusterHealthChunkQueryDescription queryDescription);
member this.GetClusterHealthChunkAsync : System.Fabric.Description.ClusterHealthChunkQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk>
Public Function GetClusterHealthChunkAsync (queryDescription As ClusterHealthChunkQueryDescription) As Task(Of ClusterHealthChunk)

Parameters

queryDescription
ClusterHealthChunkQueryDescription

The query description that defines how health evaluation should be performed and what entities should be included in the ClusterHealthChunk.

Returns

Task<ClusterHealthChunk>

The health chunk representing the cluster health.

Exceptions

Caused by one of the following:

FabricHealthEntityNotFound.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Returned when a null reference is passed to a method that does not accept it as a valid argument.

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

Caused by one of the following:

ServiceTooBusy is returned when the service is too busy to process the operation.

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

The cluster aggregated health state is computed based on all entities in the cluster. Only the children that respect the filters from the input query description (if any) are included in the results.

Applies to

GetClusterHealthChunkAsync(TimeSpan, CancellationToken)

Gets the health of a Service Fabric cluster.

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk> GetClusterHealthChunkAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetClusterHealthChunkAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk>
Public Function GetClusterHealthChunkAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterHealthChunk)

Parameters

timeout
TimeSpan

The maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.

cancellationToken
CancellationToken

The optional cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is canceled.

Returns

Task<ClusterHealthChunk>

The health chunk representing the cluster health.

Exceptions

Caused by one of the following:

FabricHealthEntityNotFound.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Caused by one of the following:

ServiceTooBusy is returned when the service is too busy to process the operation.

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

The cluster aggregated health state is computed based on all entities in the cluster. No children are included in the results, because no filters are specified.

Applies to

GetClusterHealthChunkAsync(ClusterHealthChunkQueryDescription, TimeSpan, CancellationToken)

Gets the health of a Service Fabric cluster, including cluster entities as requested in the query description.

public System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk> GetClusterHealthChunkAsync (System.Fabric.Description.ClusterHealthChunkQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetClusterHealthChunkAsync : System.Fabric.Description.ClusterHealthChunkQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ClusterHealthChunk>
Public Function GetClusterHealthChunkAsync (queryDescription As ClusterHealthChunkQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterHealthChunk)

Parameters

queryDescription
ClusterHealthChunkQueryDescription

The query description that defines how health evaluation should be performed and what entities should be included in the ClusterHealthChunk.

timeout
TimeSpan

The maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.

cancellationToken
CancellationToken

The optional cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is canceled.

Returns

Task<ClusterHealthChunk>

The health chunk representing the cluster health.

Exceptions

Caused by one of the following:

FabricHealthEntityNotFound.

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Returned when a null reference is passed to a method that does not accept it as a valid argument.

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

Caused by one of the following:

ServiceTooBusy is returned when the service is too busy to process the operation.

Caused by one of the following:

E_ACCESSDENIED is returned when the access check has failed for this operation.

Remarks

The cluster aggregated health state is computed based on all entities in the cluster. Only the children that respect the filters from the input query description (if any) are included in the results.

Applies to