EntitiesOperationsExtensions.ListAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ManagementGroups

Assembly:

Microsoft.Azure.Management.ManagementGroups.dll

Package:

Microsoft.Azure.Management.ManagementGroups v2.0.0-beta

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListAsync (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", System.Threading.CancellationToken cancellationToken = default);

static member ListAsync : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>

<Extension()>
Public Function ListAsync (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", Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EntityInfo))

Parameters

operations

IEntitiesOperations

The operations group for this extension method.

skiptoken

String

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

skip

Nullable<Int32>

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

top

Nullable<Int32>

Number of elements to return when retrieving results. Passing this in will override $skipToken.

select

String

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

search

String

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results. Possible values include: 'AllowedParents', 'AllowedChildren', 'ParentAndFirstLevelChildren', 'ParentOnly', 'ChildrenOnly'

filter

String

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

view

String

The view parameter allows clients to filter the type of data that is returned by the getEntities call. Possible values include: 'FullHierarchy', 'GroupsOnly', 'SubscriptionsOnly', 'Audit'

groupName

String

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

cacheControl

String

Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IPage<EntityInfo>>