FabricClient.QueryClient.GetDeployedApplicationListAsync Method

Reference

Definition

Namespace:: System.Fabric

Assembly:: System.Fabric.dll

Package:: Microsoft.ServiceFabric v9.1.1833

Package:: Microsoft.ServiceFabric v8.2.1748

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetDeployedApplicationListAsync(String, Uri)	Gets the deployed applications on a node with the specified application name. For more functionality, use GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription). This method will be deprecated in the future.
GetDeployedApplicationListAsync(String)	Gets the deployed application list. For more functionality, use GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription). This method will be deprecated in the future.
GetDeployedApplicationListAsync(String, Uri, TimeSpan, CancellationToken)	Gets the deployed applications on a node with the specified application name. For more functionality, use GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription, TimeSpan, CancellationToken). This method will be deprecated in the future.

GetDeployedApplicationListAsync(String, Uri)

Gets the deployed applications on a node with the specified application name. For more functionality, use GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription). This method will be deprecated in the future.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList> GetDeployedApplicationListAsync (string nodeName, Uri applicationNameFilter);

member this.GetDeployedApplicationListAsync : string * Uri -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList>

Public Function GetDeployedApplicationListAsync (nodeName As String, applicationNameFilter As Uri) As Task(Of DeployedApplicationList)

Parameters

nodeName: String

The name of the node to get applications for. This is a case-sensitive exact match. This value should not be null or empty, and if the node name does not match any node on the cluster, an exception is thrown.

applicationNameFilter: Uri

Filter results to include only applications matching this application name.

Returns

Task<DeployedApplicationList>

A task that represents the asynchronous query operation.

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

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.

Applies to

GetDeployedApplicationListAsync(String)

Gets the deployed application list. For more functionality, use GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription). This method will be deprecated in the future.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList> GetDeployedApplicationListAsync (string nodeName);

member this.GetDeployedApplicationListAsync : string -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList>

Public Function GetDeployedApplicationListAsync (nodeName As String) As Task(Of DeployedApplicationList)

Parameters

nodeName: String

Returns

Task<DeployedApplicationList>

A task that represents the asynchronous query operation.

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

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.

Applies to

GetDeployedApplicationListAsync(String, Uri, TimeSpan, CancellationToken)

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList> GetDeployedApplicationListAsync (string nodeName, Uri applicationNameFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetDeployedApplicationListAsync : string * Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedApplicationList>

Public Function GetDeployedApplicationListAsync (nodeName As String, applicationNameFilter As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of DeployedApplicationList)