FabricClient.PropertyManagementClient.EnumeratePropertiesAsync Methode

Definition

Überlädt

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)

Listet alle Service Fabric-Eigenschaften unter einem angegebenen Namen auf.

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

Listet alle Service Fabric-Eigenschaften unter einem angegebenen Namen auf.

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)

Listet alle Service Fabric-Eigenschaften unter einem angegebenen Namen auf.

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)

Parameter

name
Uri

Der übergeordnete Service Fabric-Name.

includeValues
Boolean

True , wenn Werte mit den Metadaten zurückgegeben werden sollen. False , um nur Eigenschaftsmetadaten zurückzugeben; true , um Eigenschaftsmetadaten und -wert zurückzugeben.

previousResult
PropertyEnumerationResult

Das Batchergebnis für den vorherigen Aufruf. Wenn dies der erste Aufruf ist, muss dieses Feld auf NULL festgelegt werden.

Gibt zurück

Eine Aufgabe, die den asynchronen Get-Vorgang darstellt.

Wenn HasMoreData true ist, kann dieses Ergebnis als Eingabe für den nächsten EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) Aufruf verwendet werden.

Ausnahmen

Verursacht durch eine der folgenden:

E_INVALIDARG wird zurückgegeben, wenn mindestens ein Argument ungültig ist.

Verursacht durch eine der folgenden:

E_POINTER wird zurückgegeben, wenn ein NULL-Verweis an eine Methode übergeben wird, die ihn nicht als gültiges Argument akzeptiert.

Verursacht durch eine der folgenden:

NameNotFound wird zurückgegeben, wenn der angegebene name Benutzer nicht vorhanden ist.

Verursacht durch eine der folgenden:

E_ABORT wird zurückgegeben, wenn der Vorgang abgebrochen wurde.

Informationen zur Behandlung allgemeiner FabricClient-Fehler finden Sie unter https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions .

Informationen zur Behandlung allgemeiner FabricClient-Fehler finden Sie unter https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions .

Verursacht durch eine der folgenden:

InvalidNameUri wird zurückgegeben, wenn name kein gültiger Service Fabric-Name ist.

Siehe auch https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions zur Behandlung allgemeiner FabricClient-Fehler.

Diese Ausnahme wird ausgelöst, wenn ein interner Fehler aufgetreten ist.

Hinweise

Das Timeout für den Vorgang wird auf das Standardtimeout (1 Minute) festgelegt.

Gilt für:

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

Listet alle Service Fabric-Eigenschaften unter einem angegebenen Namen auf.

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)

Parameter

name
Uri

Der übergeordnete Service Fabric-Name.

includeValues
Boolean

True , wenn die Werte mit den Metadaten zurückgegeben werden sollen. False , um nur Eigenschaftsmetadaten zurückzugeben; true, um Eigenschaftsmetadaten und -wert zurückzugeben.

previousResult
PropertyEnumerationResult

Das Batchergebnis für den vorherigen Aufruf. Wenn dies der erste Aufruf ist, muss dieses Feld auf NULL festgelegt werden.

timeout
TimeSpan

Die maximale Zeit, die das System ermöglicht, diesen Vorgang fortzusetzen, bevor zurückgegeben TimeoutExceptionwird.

cancellationToken
CancellationToken

Der CancellationToken , den der Vorgang beobachtet. Es kann verwendet werden, um die Benachrichtigung zu verbreiten, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Eine Aufgabe, die den asynchronen Get-Vorgang darstellt.

Wenn HasMoreData true ist, kann dieses Ergebnis als Eingabe für den nächsten EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) Aufruf verwendet werden.

Ausnahmen

Verursacht durch eine der folgenden:

E_INVALIDARG wird zurückgegeben, wenn mindestens ein Argument ungültig ist.

Verursacht durch eine der folgenden:

E_POINTER wird zurückgegeben, wenn ein NULL-Verweis an eine Methode übergeben wird, die ihn nicht als gültiges Argument akzeptiert.

Verursacht durch eine der folgenden:

NameNotFound wird zurückgegeben, wenn der angegebene name Benutzer nicht vorhanden ist.

Verursacht durch eine der folgenden:

E_ABORT wird zurückgegeben, wenn der Vorgang abgebrochen wurde.

Informationen zur Behandlung allgemeiner FabricClient-Fehler finden Sie unter https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions .

Informationen zur Behandlung allgemeiner FabricClient-Fehler finden Sie unter https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions .

Verursacht durch eine der folgenden:

InvalidNameUri wird zurückgegeben, wenn name kein gültiger Service Fabric-Name ist.

Siehe auch https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions zur Behandlung allgemeiner FabricClient-Fehler.

Diese Ausnahme wird ausgelöst, wenn ein interner Fehler aufgetreten ist.

Hinweise

Das Timeout für den Vorgang wird auf das Standardtimeout (1 Minute) festgelegt.

Gilt für: