你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
EntitiesOperationsExtensions.List 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
列出已通过身份验证的用户的所有实体(管理组、订阅等)。
public static Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> List (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache");
static member List : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string -> Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>
<Extension()>
Public Function List (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache") As IPage(Of EntityInfo)
参数
- operations
- IEntitiesOperations
此扩展方法的操作组。
- skiptoken
- String
仅当上一个操作返回了部分结果时,才使用页继续标记。 如果上一个响应包含 nextLink 元素,则 nextLink 元素的值将包含一个标记参数,该参数指定用于后续调用的起点。
- select
- String
此参数指定要包含在响应中的字段。 可以包含 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain 的任意组合,例如“$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain”。 指定后,$select参数可以替代$skipToken中的 select。
- search
- String
$search 参数与 $filter 参数结合使用,根据传入的参数返回三个不同的输出。 使用 $search=AllowedParents 时,API 将返回请求的实体能够重定父级的所有组的实体信息,由用户的权限决定。 使用 $search=AllowedChildren 时,API 将返回可添加为所请求实体的子级的所有实体的实体信息。 使用 $search=ParentAndFirstLevelChildren 时,API 将返回用户直接访问或通过子代之一间接访问的父级和第一级子级。 使用 $search=ParentOnly 时,如果用户至少有权访问该组的一个后代,API 将仅返回该组。 使用 $search=ChildrenOnly 时,API 将仅返回$filter中指定的组实体信息的第一级子级。 用户必须具有对子实体或其后代之一的直接访问权限,才能显示在结果中。 可能的值包括:“AllowedParents”、“AllowedChildren”、“ParentAndFirstLevelChildren”、“ParentOnly”、“ChildrenOnly”
- filter
- String
使用 filter 参数可以筛选名称或显示名称字段。 可以检查名称字段 (的相等性,例如名称 eq “{entityName}”) ,并且可以检查名称字段或显示名称字段的子字符串 (例如,包含 (名称,“{substringToSearch}”) ,包含 (displayName,“{substringToSearch”) ) 。 请注意,“{entityName}”和“{substringToSearch}”字段不区分大小写。
- view
- String
视图参数允许客户端筛选 getEntities 调用返回的数据类型。 可能的值包括:“FullHierarchy”、“GroupsOnly”、“SubscriptionsOnly”、“Audit”
- groupName
- String
一个筛选器,允许获取实体调用专注于特定组 (,即“$filter=name eq 'groupName'”)
- cacheControl
- String
指示请求是否应利用任何缓存。 使用“no-cache”值填充标头以绕过现有缓存。