FabricClient.PropertyManagementClient.EnumeratePropertiesAsync Method

Definition

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
System.Uri

The parent Service Fabric name.

includeValues
System.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

System.Threading.Tasks.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

System.ArgumentException

Caused by one of the following:

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

System.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.

Caused by one of the following:

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

System.OperationCanceledException

Caused by one of the following:

E_ABORT is returned when operation was aborted.

System.TimeoutException

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

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.

System.Runtime.InteropServices.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>

Parameters

name
System.Uri

The parent Service Fabric name.

includeValues
System.Boolean

True if the 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.

timeout
System.TimeSpan

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

cancellationToken
System.Threading.CancellationToken

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

Returns

System.Threading.Tasks.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

System.ArgumentException

Caused by one of the following:

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

System.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.

Caused by one of the following:

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

System.OperationCanceledException

Caused by one of the following:

E_ABORT is returned when operation was aborted.

System.TimeoutException

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

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.

System.Runtime.InteropServices.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