Condividi tramite


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

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

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.

Caused by one of the following:

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

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)

Parameters

name
Uri

The parent Service Fabric name.

includeValues
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
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 get operation.

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

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.

Caused by one of the following:

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