FabricClient.PropertyManagementClient.EnumerateSubNamesAsync 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

EnumerateSubNamesAsync(Uri, NameEnumerationResult, Boolean)	Enumerates all the Service Fabric names under a given name.
EnumerateSubNamesAsync(Uri, NameEnumerationResult, Boolean, TimeSpan, CancellationToken)	Enumerates all the Service Fabric names under a given name.

EnumerateSubNamesAsync(Uri, NameEnumerationResult, Boolean)

Enumerates all the Service Fabric names under a given name.

public System.Threading.Tasks.Task<System.Fabric.NameEnumerationResult> EnumerateSubNamesAsync (Uri name, System.Fabric.NameEnumerationResult previousResult, bool recursive);

member this.EnumerateSubNamesAsync : Uri * System.Fabric.NameEnumerationResult * bool -> System.Threading.Tasks.Task<System.Fabric.NameEnumerationResult>

Public Function EnumerateSubNamesAsync (name As Uri, previousResult As NameEnumerationResult, recursive As Boolean) As Task(Of NameEnumerationResult)

Parameters

name: Uri

The parent Service Fabric name to be enumerated.

previousResult: NameEnumerationResult

The result that was returned by the previous enumerate call. For the initial call, this is null.

recursive: Boolean

True the enumeration should be recursive.

Returns

Task<NameEnumerationResult>

A task that represents the asynchronous enumerate operation.

See NameEnumerationResult.

Exceptions

ArgumentException

Caused by one of the following:

E_INVALIDARG is returned when one or more arguments are not valid.

ArgumentNullException

Caused by one of the following:

E_POINTER is returned when a null reference is passed to a method that does not accept it as a valid argument.

FabricElementNotFoundException

NameNotFound is returned when the user provided name does not exist.

OperationCanceledException

Caused by one of the following:

E_ABORT is returned when operation was aborted.

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

Caused by one of the following:

InvalidNameUri is returned when name is not a valid Service Fabric name.

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

COMException

This exception is thrown when an internal error has occurred.

Remarks

Timeout for the operation will be set to default timeout (1 minute).

Applies to

EnumerateSubNamesAsync(Uri, NameEnumerationResult, Boolean, TimeSpan, CancellationToken)

Enumerates all the Service Fabric names under a given name.

public System.Threading.Tasks.Task<System.Fabric.NameEnumerationResult> EnumerateSubNamesAsync (Uri name, System.Fabric.NameEnumerationResult previousResult, bool recursive, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.EnumerateSubNamesAsync : Uri * System.Fabric.NameEnumerationResult * bool * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.NameEnumerationResult>

Public Function EnumerateSubNamesAsync (name As Uri, previousResult As NameEnumerationResult, recursive As Boolean, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NameEnumerationResult)