FabricClient.QueryClient.GetApplicationListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetApplicationListAsync()	Gets the details for all applications created in the system. If the applications 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.
GetApplicationListAsync(Uri)	Gets the details for all applications or for a specific application created in the system. If the applications 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.
GetApplicationListAsync(Uri, String)	Gets the details for all applications or for a specific application created in the system. If the applications 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.
GetApplicationListAsync(Uri, TimeSpan, CancellationToken)	Gets the details for all applications or for a specific application created in the system. If the applications 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.
GetApplicationListAsync(Uri, String, TimeSpan, CancellationToken)	Gets the details for all applications or for a specific application created in the system. If the applications 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.

GetApplicationListAsync()

Gets the details for all applications created in the system. If the applications 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.ApplicationList> GetApplicationListAsync ();

member this.GetApplicationListAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Query.ApplicationList>

Public Function GetApplicationListAsync () As Task(Of ApplicationList)

Returns

Task<ApplicationList>

A task that represents the asynchronous query operation.

If the provided application name has no matching applications, it returns a list of 0 entries.

The returned task contains the list of applications as ApplicationList.

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.

GetApplicationListAsync(Uri)

Gets the details for all applications or for a specific application created in the system. If the applications 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.ApplicationList> GetApplicationListAsync (Uri applicationNameFilter);

member this.GetApplicationListAsync : Uri -> System.Threading.Tasks.Task<System.Fabric.Query.ApplicationList>

Public Function GetApplicationListAsync (applicationNameFilter As Uri) As Task(Of ApplicationList)

Parameters

applicationNameFilter

Uri

The name of the application to get details for.

Returns

Task<ApplicationList>

A task that represents the asynchronous query operation.

The returned task contains the list of applications as ApplicationList.

If the provided application name has no matching applications, it returns a list of 0 entries.

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.

GetApplicationListAsync(Uri, String)

Gets the details for all applications or for a specific application created in the system. If the applications 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.ApplicationList> GetApplicationListAsync (Uri applicationNameFilter, string continuationToken);

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

Public Function GetApplicationListAsync (applicationNameFilter As Uri, continuationToken As String) As Task(Of ApplicationList)

Parameters

applicationNameFilter

Uri

The name of the application to get details for.

continuationToken

String

The continuation token obtained from a previous query. This value can be passed along to this query to start where the last query left off. Not passing a continuation token means returned results start from the first page.

Returns

Task<ApplicationList>

A task that represents the asynchronous query operation.

The returned task contains the list of applications as ApplicationList.

If the provided application name has no matching applications, it returns a list of 0 entries.

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.

GetApplicationListAsync(Uri, TimeSpan, CancellationToken)

Gets the details for all applications or for a specific application created in the system. If the applications 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.ApplicationList> GetApplicationListAsync (Uri applicationNameFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetApplicationListAsync : Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ApplicationList>

Public Function GetApplicationListAsync (applicationNameFilter As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationList)

Parameters

applicationNameFilter

Uri

The name of the application to get details for.

timeout

TimeSpan

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

cancellationToken

CancellationToken

Propagates notification that operations should be canceled.

Returns

Task<ApplicationList>

A task that represents the asynchronous query operation.

The returned task contains the list of applications as ApplicationList.

If the provided application name has no matching applications, it returns a list of 0 entries.

Exceptions

FabricObjectClosedException

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

TimeoutException

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.

GetApplicationListAsync(Uri, String, TimeSpan, CancellationToken)

Gets the details for all applications or for a specific application created in the system. If the applications 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.ApplicationList> GetApplicationListAsync (Uri applicationNameFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

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

Public Function GetApplicationListAsync (applicationNameFilter As Uri, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationList)

Parameters

applicationNameFilter

Uri

The name of the application to get details for.

continuationToken

String

The continuation token obtained from a previous query. This value can be passed along to this query to start where the last query left off. Not passing a continuation token means returned results start from the first page.

timeout

TimeSpan

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

cancellationToken

CancellationToken

Propagates notification that operation should be canceled.

Returns

Task<ApplicationList>

A task that represents the asynchronous query operation.

The returned task contains the list of applications as ApplicationList.

If the provided application name has no matching applications, it returns a list of 0 entries.

Exceptions

FabricObjectClosedException

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

TimeoutException

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.