EntitiesListNextOptionalParams interface

指示请求是否应使用任何缓存。 使用“no-cache”值填充标头以绕过现有缓存。

cacheControl?: string

属性值

筛选器参数允许筛选名称或显示名称字段。 可以在名称字段（例如名称 eq'{entityName}'）上检查是否相等，并且可以检查名称字段或显示名称字段上的子字符串（例如 contains（name，'{substringToSearch}'），contains（displayName，'{substringToSearch'））。 请注意，“{entityName}”和“{substringToSearch}”字段不区分大小写。

filter?: string

属性值

允许获取实体调用的筛选器侧重于特定组（即“$filter=name eq 'groupName'”）

groupName?: string

属性值

$search参数与$filter参数结合使用，根据传入的参数返回三个不同的输出。 使用 $search=AllowedParents，API 将返回所请求实体能够根据用户权限决定的所有组的实体信息。 使用 $search=AllowedChildren，API 将返回可添加为所请求实体子级的所有实体的实体信息。 使用 $search=ParentAndFirstLevelChildren，API 将返回用户直接访问或间接访问其子代之一的父级和第一级子级。 使用 $search=ParentOnly 时，仅当用户有权访问该组的至少一个后代时，API 才会返回该组。 使用 $search=ChildrenOnly，API 将仅返回$filter中指定的组实体信息的第一级子级。 用户必须直接访问子实体或子实体之一，才能在结果中显示。

search?: string

属性值

此参数指定要包含在响应中的字段。 可以包括 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain 的任意组合，例如“$select=Name、DisplayName、Type、ParentDisplayNameChain、ParentNameChain”。 指定$select参数时，可以替代$skipToken中的选择。

select?: string

属性值

检索结果时要跳过的实体数。 传入此项将覆盖$skipToken。

skip?: number

属性值

仅当上一个作返回部分结果时，才使用页面延续标记。 如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个标记参数，该参数指定用于后续调用的起点。

skiptoken?: string

属性值

检索结果时要返回的元素数。 传入此项将覆盖$skipToken。

top?: number

属性值

视图参数允许客户端筛选 getEntities 调用返回的数据的类型。

view?: string

属性值

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

继承自 coreClient.OperationOptions.abortSignal

在执行请求的作时，每次从服务器接收响应时调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

继承自 coreClient.OperationOptions.onResponse

为此作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

继承自 coreClient.OperationOptions.requestOptions

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

继承自 coreClient.OperationOptions.serializerOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自 coreClient.OperationOptions.tracingOptions