你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

FabricClient.PropertyManagementClient.EnumeratePropertiesAsync 方法

定义

重载

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。

返回

表示异步获取操作的任务。

如果 HasMoreData 为 true,则此结果可用作下一次 EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) 调用的输入。

例外

由以下原因之一引起:

当一个或多个参数无效时,将返回E_INVALIDARG。

由以下原因之一引起:

将 null 引用传递给不接受该方法作为有效参数的方法时,将返回E_POINTER。

由以下原因之一引起:

NameNotFound 当用户提供的 name 不存在时返回 。

由以下原因之一引起:

操作中止时返回E_ABORT。

由以下原因之一引起:

InvalidNameUri 如果 name 不是有效的 Service Fabric 名称,则返回 。

https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions 请参阅处理常见 FabricClient 故障。

发生内部错误时会引发此异常。

注解

操作的超时将设置为默认超时 (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)

参数

name
Uri

父 Service Fabric 名称。

includeValues
Boolean

True 如果值应随元数据一起返回,则为 。 False 如果仅返回属性元数据,则为 ;如果为 true,则返回属性元数据和值。

previousResult
PropertyEnumerationResult

上一次调用的批处理结果。 如果这是第一次调用,则需要将此字段设置为 null。

timeout
TimeSpan

在返回 TimeoutException之前,系统允许此操作继续的最长时间。

cancellationToken
CancellationToken

CancellationToken操作正在观测的 。 它可用于传播应取消操作的通知。

返回

表示异步获取操作的任务。

如果 HasMoreData 为 true,则此结果可用作下一次 EnumeratePropertiesAsync(Uri, Boolean, PropertyEnumerationResult) 调用的输入。

例外

由以下原因之一引起:

当一个或多个参数无效时,将返回E_INVALIDARG。

由以下原因之一引起:

将 null 引用传递给不接受该方法作为有效参数的方法时,将返回E_POINTER。

由以下原因之一引起:

NameNotFound 当用户提供的 name 不存在时返回 。

由以下原因之一引起:

操作中止时返回E_ABORT。

由以下原因之一引起:

InvalidNameUri 如果 name 不是有效的 Service Fabric 名称,则返回 。

https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions 请参阅处理常见 FabricClient 故障。

发生内部错误时会引发此异常。

注解

操作的超时将设置为默认超时 (1 分钟) 。

适用于