FabricClient.PropertyManagementClient.EnumeratePropertiesAsync メソッド

リファレンス

定義

名前空間:: System.Fabric

アセンブリ:: System.Fabric.dll

パッケージ:: Microsoft.ServiceFabric v9.1.1833

パッケージ:: Microsoft.ServiceFabric v8.2.1748

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)	指定した名前のすべての Service Fabric プロパティを列挙します。
EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken)	指定した名前のすべての Service Fabric プロパティを列挙します。

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)

指定した名前のすべての Service Fabric プロパティを列挙します。

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)

パラメーター

name: Uri

親 Service Fabric 名。

includeValues: Boolean

True メタデータと共に値を返す必要がある場合は。 False プロパティメタデータのみを返す場合は。 true プロパティのメタデータと値を返す場合は。

previousResult: PropertyEnumerationResult

前の呼び出しのバッチ結果。これが最初の呼び出しの場合は、このフィールドを null に設定する必要があります。

戻り値

Task<PropertyEnumerationResult>

非同期の取得操作を表すタスク。

が true の場合 HasMoreData 、この結果は次 EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) の呼び出しへの入力として使用できます。

例外

ArgumentException

次のいずれかが原因で発生します。

E_INVALIDARGは、1 つ以上の引数が無効な場合に返されます。

ArgumentNullException

次のいずれかが原因で発生します。

E_POINTERは、null 参照が有効な引数として受け入れられないメソッドに渡されると返されます。

FabricElementNotFoundException

次のいずれかが原因で発生します。

NameNotFound は、指定 name されたユーザーが存在しない場合に返されます。

OperationCanceledException

次のいずれかが原因で発生します。

E_ABORTは、操作が中止されたときに返されます。

FabricObjectClosedException

一般的な FabricClient エラーの処理に関するページを参照してください https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions 。

TimeoutException

一般的な FabricClient エラーの処理に関するページを参照してください https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions 。

FabricException

次のいずれかが原因で発生します。

InvalidNameUri が有効な Service Fabric 名でない場合 name はが返されます。

一般的な FabricClient エラーの処理についても https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions 参照してください。

COMException

この例外は、内部エラーが発生したときにスローされます。

注釈

操作のタイムアウトは、既定のタイムアウト (1 分) に設定されます。

適用対象

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

指定した名前のすべての Service Fabric プロパティを列挙します。

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)