FabricClient.QueryClient.GetNodeListAsync Method

Definition

Overloads

GetNodeListAsync(String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node.

GetNodeListAsync(String, String)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetNodeListAsync(String, String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetNodeListAsync()

Gets the details for all nodes in the cluster. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetNodeListAsync(String)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetNodeListAsync(String, NodeStatusFilter, String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetNodeListAsync(String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeListAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Parameters

nodeNameFilter
System.String

The name of the node to get details for. The node name is case-insensitive. Gets all nodes if the given node name is null.

timeout
System.TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken
System.Threading.CancellationToken

Propagates notification that operations should be canceled.

Returns

System.Threading.Tasks.Task<NodeList>

A task that represents the asynchronous query operation.

The returned task contains the list of nodes as NodeList.

Exceptions

System.TimeoutException

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

Applies to

GetNodeListAsync(String, String)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, string continuationToken);
member this.GetNodeListAsync : string * string -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>
Public Function GetNodeListAsync (nodeNameFilter As String, continuationToken As String) As Task(Of NodeList)

Parameters

nodeNameFilter
System.String

The name of the node to get details for. The node name is case-insensitive. Gets all nodes if the given node name is null.

continuationToken
System.String

The continuation token obtained from a previous query.

Returns

System.Threading.Tasks.Task<NodeList>

Exceptions

System.TimeoutException

This operation has a timeout of 60 seconds.

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

Applies to

GetNodeListAsync(String, String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeListAsync : string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Parameters

nodeNameFilter
System.String

The name of the node to get details for. The node name is case-insensitive. Gets all nodes if the given node name is null.

continuationToken
System.String

The continuation token obtained from a previous query.

timeout
System.TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken
System.Threading.CancellationToken

Propagates notification that operation should be canceled.

Returns

System.Threading.Tasks.Task<NodeList>

A task that represents the asynchronous operation.

The returned task contains the list of nodes as NodeList.

Exceptions

System.TimeoutException

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

Applies to

GetNodeListAsync()

Gets the details for all nodes in the cluster. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync ();
member this.GetNodeListAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>
Public Function GetNodeListAsync () As Task(Of NodeList)

Returns

System.Threading.Tasks.Task<NodeList>

A task that represents the asynchronous query operation.

The returned task contains the list of nodes as NodeList.

Exceptions

System.TimeoutException

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

Applies to

GetNodeListAsync(String)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter);
member this.GetNodeListAsync : string -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>
Public Function GetNodeListAsync (nodeNameFilter As String) As Task(Of NodeList)

Parameters

nodeNameFilter
System.String

The name of the node to get details for. The node name is case-insensitive. Gets all nodes in the cluster if the given node name is null.

Returns

System.Threading.Tasks.Task<NodeList>

A task that represents the asynchronous query operation.

The returned task contains the list of nodes as NodeList.

Exceptions

System.TimeoutException

This operation has a timeout of 60 seconds.

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

Applies to

GetNodeListAsync(String, NodeStatusFilter, String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node. If the nodes do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, System.Fabric.Query.NodeStatusFilter nodeStatusFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.GetNodeListAsync : string * System.Fabric.Query.NodeStatusFilter * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Parameters

nodeNameFilter
System.String

The name of the node to get details for. The node name is case-insensitive. Gets all nodes if the given node name is null.

nodeStatusFilter
NodeStatusFilter

The node status(es) of the nodes to get details for.

continuationToken
System.String

The continuation token obtained from a previous query.

timeout
System.TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken
System.Threading.CancellationToken

Propagates notification that operation should be canceled.

Returns

System.Threading.Tasks.Task<NodeList>

A task that represents the asynchronous operation.

The returned task contains the list of nodes as NodeList.

Exceptions

System.TimeoutException

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

Applies to