FabricClient.QueryClient.GetServiceListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetServiceListAsync(Uri, Uri, String, TimeSpan, CancellationToken)	Gets the details for all services of an application or just the specified service. If the services 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.
GetServiceListAsync(Uri, Uri, TimeSpan, CancellationToken)	Gets the details for all services of an application or just the specified service. If the services 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.
GetServiceListAsync(Uri)	Gets the information about all services belonging to the application specified by the application name URI. If the services 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.
GetServiceListAsync(Uri, Uri)	Gets the details for all services of an application or just the specified service. If the services 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.
GetServiceListAsync(Uri, Uri, String)	Gets the details for all services of an application or just the specified service. If the services 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.

GetServiceListAsync(Uri, Uri, String, TimeSpan, CancellationToken)

Gets the details for all services of an application or just the specified service. If the services 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.ServiceList> GetServiceListAsync (Uri applicationName, Uri serviceNameFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

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

Public Function GetServiceListAsync (applicationName As Uri, serviceNameFilter As Uri, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceList)

Parameters

applicationName

Uri

The name of the application to get services for.

serviceNameFilter

Uri

The name of the services 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<ServiceList>

A task that represents the asynchronous operation.

The returned task contains the list of services as ServiceList.

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.

GetServiceListAsync(Uri, Uri, TimeSpan, CancellationToken)

Gets the details for all services of an application or just the specified service. If the services 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.ServiceList> GetServiceListAsync (Uri applicationName, Uri serviceNameFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

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

Public Function GetServiceListAsync (applicationName As Uri, serviceNameFilter As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceList)

Parameters

applicationName

Uri

The name of the application to get services for.

serviceNameFilter

Uri

The name of the services 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<ServiceList>

A task that represents the asynchronous query operation.

The returned task contains the list of services as ServiceList.

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.

GetServiceListAsync(Uri)

Gets the information about all services belonging to the application specified by the application name URI. If the services 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.ServiceList> GetServiceListAsync (Uri applicationName);

member this.GetServiceListAsync : Uri -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceList>

Public Function GetServiceListAsync (applicationName As Uri) As Task(Of ServiceList)

Parameters

applicationName

Uri

The name of the application to get services for.

Returns

Task<ServiceList>

A task that represents the asynchronous query operation.

The returned task contains the list of services as ServiceList.

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.

GetServiceListAsync(Uri, Uri)

Gets the details for all services of an application or just the specified service. If the services 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.ServiceList> GetServiceListAsync (Uri applicationName, Uri serviceNameFilter);

member this.GetServiceListAsync : Uri * Uri -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceList>

Public Function GetServiceListAsync (applicationName As Uri, serviceNameFilter As Uri) As Task(Of ServiceList)

Parameters

applicationName

Uri

The name of the application to get services for.

serviceNameFilter

Uri

The name of the services to get details for.

Returns

Task<ServiceList>

A task that represents the asynchronous query operation.

The returned task contains the list of services as ServiceList.

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.

GetServiceListAsync(Uri, Uri, String)

Gets the details for all services of an application or just the specified service. If the services 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.ServiceList> GetServiceListAsync (Uri applicationName, Uri serviceNameFilter, string continuationToken);

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

Public Function GetServiceListAsync (applicationName As Uri, serviceNameFilter As Uri, continuationToken As String) As Task(Of ServiceList)

Parameters

applicationName

Uri

The name of the application to get services for.

serviceNameFilter

Uri

The name of the services 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<ServiceList>

A task that represents the asynchronous operation.

The returned task contains the list of services as ServiceList.

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.