Skip to main content
Version: Next

MicrosoftGraphClient.getGroups()

Home > @backstage/plugin-catalog-backend-module-msgraph > MicrosoftGraphClient > getGroups

Get a collection of Group from Graph API and return as AsyncIterable

Signature:

getGroups(query?: ODataQuery, queryMode?: 'basic' | 'advanced'): AsyncIterable<MicrosoftGraph.Group>;

Parameters

Parameter

Type

Description

query

ODataQuery

(Optional) OData Query ODataQuery

queryMode

'basic' | 'advanced'

(Optional) Mode to use while querying. Some features are only available at "advanced".

**Returns:**

AsyncIterable<MicrosoftGraph.Group>