Share via

Get-MgBetaEducationClass

  • Reference
Module:
Microsoft.Graph.Beta.Education

Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members.

Note

To view the v1.0 release of this cmdlet, view Get-MgEducationClass

Syntax

Get-MgBetaEducationClass
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-Filter <String>]
   [-Search <String>]
   [-Skip <Int32>]
   [-Sort <String[]>]
   [-Top <Int32>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PageSize <Int32>]
   [-All]
   [-CountVariable <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgBetaEducationClass
   -EducationClassId <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgBetaEducationClass
   -InputObject <IEducationIdentity>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EduRoster.ReadBasic Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduRoster.Read.All EduRoster.ReadWrite.All

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Education

Get-MgBetaEducationClass

This example shows how to use the Get-MgBetaEducationClass Cmdlet.

Parameters

-All

List all pages.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Type:String
Aliases:CV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EducationClassId

The unique identifier of educationClass

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExpandProperty

Expand related entities

Type:String[]
Aliases:Expand
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Filter items by property values

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IEducationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PageSize

Sets the page size of results.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

Select properties to be returned

Type:String[]
Aliases:Select
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Search

Search items by search phrases

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Skip

Skip the first n items

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Sort

Order items by property values

Type:String[]
Aliases:OrderBy
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

Show only the first n items

Type:Int32
Aliases:Limit
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IEducationIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphEducationClass

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IEducationIdentity>: Identity Parameter

  • [EducationAssignmentId <String>]: The unique identifier of educationAssignment
  • [EducationAssignmentResourceId <String>]: The unique identifier of educationAssignmentResource
  • [EducationAssignmentResourceId1 <String>]: The unique identifier of educationAssignmentResource
  • [EducationCategoryId <String>]: The unique identifier of educationCategory
  • [EducationClassId <String>]: The unique identifier of educationClass
  • [EducationGradingCategoryId <String>]: The unique identifier of educationGradingCategory
  • [EducationGradingSchemeId <String>]: The unique identifier of educationGradingScheme
  • [EducationModuleId <String>]: The unique identifier of educationModule
  • [EducationModuleResourceId <String>]: The unique identifier of educationModuleResource
  • [EducationOutcomeId <String>]: The unique identifier of educationOutcome
  • [EducationRubricId <String>]: The unique identifier of educationRubric
  • [EducationSchoolId <String>]: The unique identifier of educationSchool
  • [EducationSubmissionId <String>]: The unique identifier of educationSubmission
  • [EducationSubmissionResourceId <String>]: The unique identifier of educationSubmissionResource
  • [EducationSubmissionResourceId1 <String>]: The unique identifier of educationSubmissionResource
  • [EducationSynchronizationErrorId <String>]: The unique identifier of educationSynchronizationError
  • [EducationSynchronizationProfileId <String>]: The unique identifier of educationSynchronizationProfile
  • [EducationUserId <String>]: The unique identifier of educationUser