FabricClient.QueryClient.GetDeployedReplicaListAsync 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

GetDeployedReplicaListAsync(String, Uri, String, Nullable<Guid>, TimeSpan, CancellationToken)	Gets the view of replicas from a node.
GetDeployedReplicaListAsync(String, Uri, String, Nullable<Guid>)	Gets the view of replicas from a node.
GetDeployedReplicaListAsync(String, Uri)	Gets the view of replicas from a node.
GetDeployedReplicaListAsync(String, Uri, Nullable<Guid>)	Gets the view of replicas from a node.

GetDeployedReplicaListAsync(String, Uri, String, Nullable<Guid>, TimeSpan, CancellationToken)

Gets the view of replicas from a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList> GetDeployedReplicaListAsync (string nodeName, Uri applicationName, string serviceManifestNameFilter, Guid? partitionIdFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetDeployedReplicaListAsync : string * Uri * string * Nullable<Guid> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList>

Public Function GetDeployedReplicaListAsync (nodeName As String, applicationName As Uri, serviceManifestNameFilter As String, partitionIdFilter As Nullable(Of Guid), timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of DeployedServiceReplicaList)

Parameters

nodeName: String

The name of the node. 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.

applicationName: Uri

The name of the application.

serviceManifestNameFilter: String

Filter results to include only those matching this service manifest name.

partitionIdFilter: Nullable<Guid>

Filter results to only include replicas matching this partition ID.

timeout: TimeSpan

The timespan that defines the maximum amount of time will allow this operation to continue before returning a TimeoutException.

cancellationToken: CancellationToken

The optional cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is canceled.

Returns

Task<DeployedServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed service replicas as DeployedServiceReplicaList.

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.

FabricInvalidAddressException

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

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetReplicaListAsync(Guid) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

Applies to

GetDeployedReplicaListAsync(String, Uri, String, Nullable<Guid>)

Gets the view of replicas from a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList> GetDeployedReplicaListAsync (string nodeName, Uri applicationName, string serviceManifestNameFilter, Guid? partitionIdFilter);

member this.GetDeployedReplicaListAsync : string * Uri * string * Nullable<Guid> -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList>

Public Function GetDeployedReplicaListAsync (nodeName As String, applicationName As Uri, serviceManifestNameFilter As String, partitionIdFilter As Nullable(Of Guid)) As Task(Of DeployedServiceReplicaList)

Parameters

nodeName: String

The name of the node. 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.

applicationName: Uri

The name of the application.

serviceManifestNameFilter: String

Filter results to include only those matching this service manifest name.

partitionIdFilter: Nullable<Guid>

Filter results to only include replicas matching this partition ID.

Returns

Task<DeployedServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed service replicas as DeployedServiceReplicaList.

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

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetReplicaListAsync(Guid) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

Applies to

GetDeployedReplicaListAsync(String, Uri)

Gets the view of replicas from a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList> GetDeployedReplicaListAsync (string nodeName, Uri applicationName);

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

Public Function GetDeployedReplicaListAsync (nodeName As String, applicationName As Uri) As Task(Of DeployedServiceReplicaList)

Parameters

nodeName: String

The name of the node. 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.

applicationName: Uri

The name of the application.

Returns

Task<DeployedServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed service replicas as DeployedServiceReplicaList.

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

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetReplicaListAsync(Guid) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

Applies to

GetDeployedReplicaListAsync(String, Uri, Nullable<Guid>)

Gets the view of replicas from a node.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList> GetDeployedReplicaListAsync (string nodeName, Uri applicationName, Guid? partitionIdFilter);

member this.GetDeployedReplicaListAsync : string * Uri * Nullable<Guid> -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedServiceReplicaList>

Public Function GetDeployedReplicaListAsync (nodeName As String, applicationName As Uri, partitionIdFilter As Nullable(Of Guid)) As Task(Of DeployedServiceReplicaList)

Parameters

nodeName: String

The name of the node. 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.