ManagementGroupCollectionGetEntitiesOptions.Search Property

Definition

Namespace:

Azure.ResourceManager.ManagementGroups.Models

Assembly:

Azure.ResourceManager.dll

Package:

Azure.ResourceManager v1.12.0

Source:

ManagementGroupCollectionGetEntitiesOptions.cs

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 Azure.ResourceManager.ManagementGroups.Models.EntitySearchOption? Search { get; set; }

member this.Search : Nullable<Azure.ResourceManager.ManagementGroups.Models.EntitySearchOption> with get, set

Public Property Search As Nullable(Of EntitySearchOption)

Property Value

Nullable<EntitySearchOption>