Class ManagementGroupCollectionGetEntitiesOptions

Namespace

Azure.ResourceManager.ManagementGroups.Models

Assembly

Azure.ResourceManager.dll

The ManagementGroupCollectionGetEntitiesOptions.

public class ManagementGroupCollectionGetEntitiesOptions

Inheritance

object

ManagementGroupCollectionGetEntitiesOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ManagementGroupCollectionGetEntitiesOptions()

Initializes a new instance of ManagementGroupCollectionGetEntitiesOptions.

public ManagementGroupCollectionGetEntitiesOptions()

Properties

CacheControl

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

public string CacheControl { get; set; }

Property Value

string

Filter

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.

public string Filter { get; set; }

Property Value

string

GroupName

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

public string GroupName { get; set; }

Property Value

string

Search

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.

public EntitySearchOption? Search { get; set; }

Property Value

EntitySearchOption?

Select

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.

public string Select { get; set; }

Property Value

string

Skip

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

public int? Skip { get; set; }

Property Value

int?

SkipToken

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.

public string SkipToken { get; set; }

Property Value

string

Top

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

public int? Top { get; set; }

Property Value

int?

View

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

public EntityViewOption? View { get; set; }

Property Value

EntityViewOption?