Dela via


FabricClient.PropertyManagementClient.EnumerateSubNamesAsync Method

Definition

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

A task that represents the asynchronous enumerate operation.

See NameEnumerationResult.

Exceptions

Caused by one of the following:

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

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.

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

Caused by one of the following:

E_ABORT is returned when operation was aborted.

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.

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)

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 if the enumeration should be recursive.

timeout
TimeSpan

The maximum amount of time the system will allow this operation to continue before returning TimeoutException.

cancellationToken
CancellationToken

The CancellationToken that the operation is observing. It can be used to propagate notification that the operation should be canceled.

Returns

A task that represents the asynchronous enumerate operation.

See NameEnumerationResult.

Exceptions

Caused by one of the following:

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

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.

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

Caused by one of the following:

E_ABORT is returned when operation was aborted.

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.

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