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

EntitiesListOptionalParams interface

包:

@azure/arm-managementgroups

可选参数。

Extends

OperationOptions

属性

cacheControl	指示请求是否应利用任何缓存。 使用“no-cache”值填充标头以绕过现有缓存。
filter	使用 filter 参数可以筛选名称字段或显示名称字段。 可以在名称字段 (例如 name eq “{entityName}”) ）上检查相等，并且可以检查名称字段或显示名称字段上的子字符串 (例如，包含 (名称、“{substringToSearch}”) 、contains (displayName、“{substringToSearch”) ) 。 请注意，“{entityName}”和“{substringToSearch}”字段不区分大小写。
groupName	一个筛选器，允许获取实体调用专注于特定组 (即“$filter=name eq 'groupName'”)
search	$search 参数与 $filter 参数结合使用，根据传入的参数返回三个不同的输出。 使用 $search=AllowedParents 时，API 将返回请求的实体能够根据用户权限确定的所有组的实体信息。 使用 $search=AllowedChildren，API 将返回可添加为所请求实体子级的所有实体的实体信息。 使用 $search=ParentAndFirstLevelChildren，API 将返回父级和第一级子级，用户有权直接访问或通过其一个后代间接访问。 使用 $search=ParentOnly 时，如果用户至少有权访问该组的一个后代，则 API 将仅返回该组。 使用 $search=ChildrenOnly 时，API 将仅返回$filter中指定的组实体信息的第一级子级。 用户必须具有对子实体或其子实体之一的直接访问权限，才能显示在结果中。
select	此参数指定要包含在响应中的字段。 可以包括 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain 的任意组合，例如“$select=Name，DisplayName，Type，ParentDisplayNameChain，ParentNameChain”。 指定后，$select参数可以替代$skipToken中的选择。
skip	检索结果时要跳过的实体数。 传入此项将覆盖$skipToken。
skiptoken	仅当上一个操作返回部分结果时，才使用页面延续标记。 如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个标记参数，该参数指定要用于后续调用的起点。
top	检索结果时要返回的元素数。 传入此项将覆盖$skipToken。
view	view 参数允许客户端筛选 getEntities 调用返回的数据类型。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的操作时，每次从服务器收到响应时要调用的函数。 可以多次调用。
requestOptions	创建和发送此操作的 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/反序列化行为的选项。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

cacheControl

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

cacheControl?: string

属性值

string

filter

使用 filter 参数可以筛选名称字段或显示名称字段。 可以在名称字段 (例如 name eq “{entityName}”) ）上检查相等，并且可以检查名称字段或显示名称字段上的子字符串 (例如，包含 (名称、“{substringToSearch}”) 、contains (displayName、“{substringToSearch”) ) 。 请注意，“{entityName}”和“{substringToSearch}”字段不区分大小写。

filter?: string

属性值

string

groupName

一个筛选器，允许获取实体调用专注于特定组 (即“$filter=name eq 'groupName'”)

groupName?: string

属性值

string

search

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

search?: string

属性值

string

select

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

select?: string

属性值

string

skip

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

skip?: number

属性值

number

skiptoken

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

skiptoken?: string

属性值

string

top

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

top?: number

属性值

number

view

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

view?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 coreClient.OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

属性值

RawResponseCallback

继承自 coreClient.OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

属性值

OperationRequestOptions

继承自 coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自 coreClient.OperationOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 coreClient.OperationOptions.tracingOptions