FabricClient.QueryClient.GetDeployedApplicationPagedListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription, TimeSpan, CancellationToken)	Gets the list of applications deployed on a node.
GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription)	Gets the list of applications deployed on a node.

GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription, TimeSpan, CancellationToken)

Gets the list of applications deployed on a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationPagedList> GetDeployedApplicationPagedListAsync (System.Fabric.Description.PagedDeployedApplicationQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetDeployedApplicationPagedListAsync : System.Fabric.Description.PagedDeployedApplicationQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationPagedList>

Public Function GetDeployedApplicationPagedListAsync (queryDescription As PagedDeployedApplicationQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of DeployedApplicationPagedList)

Parameters

queryDescription

PagedDeployedApplicationQueryDescription

A PagedDeployedApplicationQueryDescription object describing which deployed applications to return.

timeout

TimeSpan

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

cancellationToken

CancellationToken

Propagates notification that operations should be canceled.

Returns

Task<DeployedApplicationPagedList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed applications as DeployedApplicationPagedList.

This query returns empty rather than an error if no application types are found matching the filters provided.

Exceptions

FabricObjectClosedException

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

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.

FabricException

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

FabricInvalidAddressException

For this query, this exception usually means that the given node name does not match any node in the cluster.

Remarks

This is a paged query, meaning that if not all of the applications 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. For example, if there are 10000 applications but a page only fits the first 3000 applications, 3000 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. A null continuation token is returned if there are no subsequent pages.

GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription)

Gets the list of applications deployed on a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationPagedList> GetDeployedApplicationPagedListAsync (System.Fabric.Description.PagedDeployedApplicationQueryDescription queryDescription);

member this.GetDeployedApplicationPagedListAsync : System.Fabric.Description.PagedDeployedApplicationQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationPagedList>

Public Function GetDeployedApplicationPagedListAsync (queryDescription As PagedDeployedApplicationQueryDescription) As Task(Of DeployedApplicationPagedList)

Parameters

queryDescription

PagedDeployedApplicationQueryDescription

A PagedDeployedApplicationQueryDescription object describing which deployed applications to return.

Returns

Task<DeployedApplicationPagedList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed applications as DeployedApplicationPagedList.

This query returns empty rather than an error if no results are found matching the filters provided.

Exceptions

FabricObjectClosedException

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

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.

FabricException

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

FabricInvalidAddressException

For this query, this exception usually means that the given node name does not match any node in the cluster.

Remarks

This is a paged query, meaning that if not all of the applications 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. For example, if there are 10000 applications but a page only fits the first 3000 applications, 3000 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. A null continuation token is returned if there are no subsequent pages.