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

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)	Enumerates all Service Fabric properties under a given name.
EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken)	Enumerates all Service Fabric properties under a given name.

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)

Enumerates all Service Fabric properties under a given name.

public System.Threading.Tasks.Task<System.Fabric.PropertyEnumerationResult> EnumeratePropertiesAsync (Uri name, bool includeValues, System.Fabric.PropertyEnumerationResult previousResult);

member this.EnumeratePropertiesAsync : Uri * bool * System.Fabric.PropertyEnumerationResult -> System.Threading.Tasks.Task<System.Fabric.PropertyEnumerationResult>

Public Function EnumeratePropertiesAsync (name As Uri, includeValues As Boolean, previousResult As PropertyEnumerationResult) As Task(Of PropertyEnumerationResult)

Parameters

name: Uri

The parent Service Fabric name.

includeValues: Boolean

True if values should be returned with the metadata. False to return only property metadata; true to return property metadata and value.

previousResult: PropertyEnumerationResult

The batch result for the previous call. If this the first call, this field needs to be set to null.

Returns

Task<PropertyEnumerationResult>

A task that represents the asynchronous get operation.

If HasMoreData is true, then this result can be used as input to the next EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) call.

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

Caused by one of the following:

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

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken)

Enumerates all Service Fabric properties under a given name.

public System.Threading.Tasks.Task<System.Fabric.PropertyEnumerationResult> EnumeratePropertiesAsync (Uri name, bool includeValues, System.Fabric.PropertyEnumerationResult previousResult, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

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

Public Function EnumeratePropertiesAsync (name As Uri, includeValues As Boolean, previousResult As PropertyEnumerationResult, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PropertyEnumerationResult)