FabricClient.PropertyManagementClient.EnumeratePropertiesAsync Méthode

Définition

Espace de noms:

System.Fabric

Assembly:

System.Fabric.dll

Paquet:

Microsoft.ServiceFabric v9.1.1833

Surcharges

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)	Énumère toutes les propriétés Service Fabric sous un nom donné.
EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken)	Énumère toutes les propriétés Service Fabric sous un nom donné.

EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)

Énumère toutes les propriétés Service Fabric sous un nom donné.

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)

Paramètres

name

Uri

Nom Service Fabric parent.

includeValues

Boolean

True si les valeurs doivent être retournées avec les métadonnées. False pour renvoyer uniquement les métadonnées de propriété ; true pour retourner les métadonnées et la valeur de la propriété.

previousResult

PropertyEnumerationResult

Résultat du lot de l’appel précédent. S’il s’agit du premier appel, ce champ doit être défini sur null.

Retours

Task<PropertyEnumerationResult>

Tâche qui représente l’opération d’obtention asynchrone.

Si HasMoreData est true, ce résultat peut être utilisé comme entrée pour l’appel suivant EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) .

Exceptions

ArgumentException

Causé par l’un des éléments suivants :

E_INVALIDARG est retourné lorsqu’un ou plusieurs arguments ne sont pas valides.

ArgumentNullException

Causé par l’un des éléments suivants :

E_POINTER est retourné lorsqu’une référence null est passée à une méthode qui ne l’accepte pas comme argument valide.

FabricElementNotFoundException

Causé par l’un des éléments suivants :

NameNotFound est retourné lorsque l’utilisateur fourni name n’existe pas.

OperationCanceledException

Causé par l’un des éléments suivants :

E_ABORT est retourné lorsque l’opération a été abandonnée.

FabricObjectClosedException

Consultez https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

TimeoutException

Consultez https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

FabricException

Causé par l’un des éléments suivants :

InvalidNameUri est retourné lorsque name n’est pas un nom Service Fabric valide.

Consultez également https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

COMException

Cette exception est levée lorsqu’une erreur interne s’est produite.

Remarques

Le délai d’expiration de l’opération est défini sur le délai d’expiration par défaut (1 minute).

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

Énumère toutes les propriétés Service Fabric sous un nom donné.

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)

Paramètres

name

Uri

Nom Service Fabric parent.

includeValues

Boolean

True si les valeurs doivent être retournées avec les métadonnées. False pour renvoyer uniquement les métadonnées de propriété ; true pour renvoyer les métadonnées et la valeur de propriété.

previousResult

PropertyEnumerationResult

Résultat du lot de l’appel précédent. S’il s’agit du premier appel, ce champ doit être défini sur null.

timeout

TimeSpan

Durée maximale pendant laquelle le système autorise cette opération à se poursuivre avant de retourner TimeoutException.

cancellationToken

CancellationToken

CancellationToken que l’opération observe. Il peut être utilisé pour propager une notification indiquant que l’opération doit être annulée.

Retours

Task<PropertyEnumerationResult>

Tâche qui représente l’opération d’obtention asynchrone.

Si HasMoreData est true, ce résultat peut être utilisé comme entrée pour l’appel suivant EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) .

Exceptions

ArgumentException

Causé par l’un des éléments suivants :

E_INVALIDARG est retourné lorsqu’un ou plusieurs arguments ne sont pas valides.

ArgumentNullException

Causé par l’un des éléments suivants :

E_POINTER est retourné lorsqu’une référence null est passée à une méthode qui ne l’accepte pas comme argument valide.

FabricElementNotFoundException

Causé par l’un des éléments suivants :

NameNotFound est retourné lorsque l’utilisateur fourni name n’existe pas.

OperationCanceledException

Causé par l’un des éléments suivants :

E_ABORT est retourné lorsque l’opération a été abandonnée.

FabricObjectClosedException

Consultez https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

TimeoutException

Consultez https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

FabricException

Causé par l’un des éléments suivants :

InvalidNameUri est retourné lorsque name n’est pas un nom Service Fabric valide.

Consultez également https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions pour la gestion des échecs FabricClient courants.

COMException

Cette exception est levée lorsqu’une erreur interne s’est produite.

Remarques

Le délai d’expiration de l’opération est défini sur le délai d’expiration par défaut (1 minute).