FabricClient.PropertyManagementClient.EnumeratePropertiesAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) |
Enumera todas as propriedades do Service Fabric em um determinado nome. |
| EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken) |
Enumera todas as propriedades do Service Fabric em um determinado nome. |
EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult)
Enumera todas as propriedades do Service Fabric em um determinado nome.
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)Parâmetros
- name
- Uri
O nome pai do Service Fabric.
- includeValues
- Boolean
True se os valores devem ser retornados com os metadados. False para retornar apenas metadados de propriedade; true para retornar metadados de propriedade e valor.
- previousResult
- PropertyEnumerationResult
O resultado do lote para a chamada anterior. Se essa for a primeira chamada, esse campo precisará ser definido como nulo.
Retornos
Uma tarefa que representa a operação de obtenção assíncrona.
Se HasMoreData for true, esse resultado poderá ser usado como entrada para a próxima EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) chamada.
Exceções
Causado por um dos seguintes:
E_INVALIDARG é retornado quando um ou mais argumentos não são válidos.
Causado por um dos seguintes:
E_POINTER é retornado quando uma referência nula é passada para um método que não a aceita como um argumento válido.
Causado por um dos seguintes:
NameNotFound é retornado quando o usuário fornecido name não existe.
Causado por um dos seguintes:
E_ABORT é retornado quando a operação foi anulada.
Consulte https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Consulte https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Causado por um dos seguintes:
InvalidNameUri é retornado quando name não é um nome válido do Service Fabric.
Consulte também https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Essa exceção é gerada quando ocorre um erro interno.
Comentários
O tempo limite para a operação será definido como tempo limite padrão (1 minuto).
Aplica-se a
EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult, TimeSpan, CancellationToken)
Enumera todas as propriedades do Service Fabric em um determinado nome.
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)Parâmetros
- name
- Uri
O nome pai do Service Fabric.
- includeValues
- Boolean
True se os valores devem ser retornados com os metadados.
False para retornar apenas metadados de propriedade; true para retornar metadados de propriedade e valor.
- previousResult
- PropertyEnumerationResult
O resultado do lote para a chamada anterior. Se essa for a primeira chamada, esse campo precisará ser definido como nulo.
- timeout
- TimeSpan
A quantidade máxima de tempo que o sistema permitirá que essa operação continue antes de TimeoutExceptionretornar .
- cancellationToken
- CancellationToken
O CancellationToken que a operação está observando. Ele pode ser usado para propagar a notificação de que a operação deve ser cancelada.
Retornos
Uma tarefa que representa a operação de obtenção assíncrona.
Se HasMoreData for true, esse resultado poderá ser usado como entrada para a próxima EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) chamada.
Exceções
Causado por um dos seguintes:
E_INVALIDARG é retornado quando um ou mais argumentos não são válidos.
Causado por um dos seguintes:
E_POINTER é retornado quando uma referência nula é passada para um método que não a aceita como um argumento válido.
Causado por um dos seguintes:
NameNotFound é retornado quando o usuário fornecido name não existe.
Causado por um dos seguintes:
E_ABORT é retornado quando a operação foi anulada.
Consulte https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Consulte https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Causado por um dos seguintes:
InvalidNameUri é retornado quando name não é um nome válido do Service Fabric.
Consulte também https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions para lidar com falhas comuns do FabricClient.
Essa exceção é gerada quando ocorre um erro interno.
Comentários
O tempo limite para a operação será definido como tempo limite padrão (1 minuto).
Aplica-se a
Azure SDK for .NET