---

Class Relations

• class: ::nx::EnsembleObject

::nx::EnsembleObject create ::ms::Graph::slot::__group

Methods (to be applied on the object)

• deleted (scripted)

  #
  # List deleted groups.
  #
  # Since groups are large objects, use $select to only get
  # the properties of the group you care about.
  #
  # Details: https://docs.microsoft.com/graph/api/directory-deleteditems-list
  #
  # @param expand retrieve related information via navigation property, e.g. members
  # @param count boolean, retrieves the total count of matching resources
  # @param filter retrieve a filtered subset of the tuples
  # @param orderby order tuples by some attribute
  # @param search returns results based on search criteria.
  # @param select return selected attributes, e.g. id,displayName,userPrincipalName
  # @param top sets the page size of results
  
  # set filter "startsWith(displayName,'Information Systems') and resourceProvisioningOptions/Any(x:x eq 'Team')"
  set r [:request -method GET -token [:token]  -url /directory/deletedItems/microsoft.graph.group?[:params {
                 count expand filter orderby search select top}]]
  return [:expect_status_code $r 200]

• get (scripted)

  #
  # Get the properties and relationships of a group object.
  # To get properties that are not returned by default,
  # specify them in a -select OData query option.
  #
  # Details: https://docs.microsoft.com/en-us/graph/api/group-get
  #
  # @param select return selected attributes, e.g. displayName,mail,visibility
  
  set r [:request -method GET -token [:token]  -url /groups/$group_id?[:params {select}]]
  return [:expect_status_code $r 200]

• list (scripted)

  #
  # To get a list of all groups in the organization that
  # have teams, filter by the resourceProvisioningOptions
  # property that contains "Team" (needs beta API):
  #    resourceProvisioningOptions/Any(x:x eq 'Team')
  # Otherwise, one has to get the full list and filter manually.
  #
  # Since groups are large objects, use $select to only get
  # the properties of the group you care about.
  #
  # Details:
  #    https://docs.microsoft.com/graph/teams-list-all-teams
  #    https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter
  #
  # @param count boolean, retrieves the total count of matching resources
  # @param expand retrieve related information via navigation property, e.g. members
  # @param filter retrieve a filtered subset of the tuples
  # @param orderby order tuples by some attribute
  # @param search returns results based on search criteria.
  # @param select return selected attributes, e.g. id,displayName,userPrincipalName
  # @param max_entries retrieve this desired number of tuples (potentially multiple API calls)
  # @param top return up this number of tuples per request (page size)
  
  # set filter "startsWith(displayName,'Information Systems') and resourceProvisioningOptions/Any(x:x eq 'Team')"
  # "contains()" seems not supported
  # set filter "contains(displayName,'Information Systems')"
  # set select {$select=id,displayName,resourceProvisioningOptions}
  
  set r [:request -method GET -token [:token]  -url https://graph.microsoft.com/beta/groups?[:params {
                 count expand select filter orderby search top}]]
  return [:paginated_result_list -max_entries $max_entries $r 200]

• memberof (scripted)

  #
  # Get groups that the group is a direct member of.
  #
  # Details: https://docs.microsoft.com/en-us/graph/api/group-list-memberof
  #
  # @param count when "true" return just a count
  # @param filter  filter criterion
  # @param search search criterion, e.g. displayName:Video
  # @param orderby sorting criterion, e.g. displayName
  #
  set r [:request -method GET -token [:token]  -url /groups/${group_id}/memberOf?[:params {
                 count filter orderby search}]]
  return [:expect_status_code $r 200]

---