Skip to content

Latest commit

 

History

History
334 lines (259 loc) · 8.11 KB

File metadata and controls

334 lines (259 loc) · 8.11 KB
external help file Module Name online version schema
Microsoft.Graph.Education-help.xml
Microsoft.Graph.Education
2.0.0

Get-MgEducationClass

SYNOPSIS

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 beta release of this cmdlet, view Get-MgBetaEducationClass

SYNTAX

List (Default)

Get-MgEducationClass [-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

Get-MgEducationClass -EducationClassId <String> [-ExpandProperty <String[]>] [-Property <String[]>]
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

GetViaIdentity

Get-MgEducationClass -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 [!INCLUDE permissions-table]

EXAMPLES

Example 1: Code snippet

Import-Module Microsoft.Graph.Education

Get-MgEducationClass

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

PARAMETERS

-All

List all pages.

Type: SwitchParameter
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: 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
Parameter Sets: List
Aliases: CV

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

-EducationClassId

The unique identifier of educationClass

Type: String
Parameter Sets: Get
Aliases:

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

-ExpandProperty

Expand related entities

Type: String[]
Parameter Sets: (All)
Aliases: Expand

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

-Filter

Filter items by property values

Type: String
Parameter Sets: List
Aliases:

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

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

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

Type: IEducationIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PageSize

Sets the page size of results.

Type: Int32
Parameter Sets: List
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-Property

Select properties to be returned

Type: String[]
Parameter Sets: (All)
Aliases: Select

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

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

-Search

Search items by search phrases

Type: String
Parameter Sets: List
Aliases:

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

-Sort

Order items by property values

Type: String[]
Parameter Sets: List
Aliases: OrderBy

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

-Top

Show only the first n items

Type: Int32
Parameter Sets: List
Aliases: Limit

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

-Skip

Skip the first n items

Type: Int32
Parameter Sets: List
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Graph.PowerShell.Models.IEducationIdentity

System.Collections.IDictionary

OUTPUTS

Microsoft.Graph.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
  • [EducationCategoryId <String>]: The unique identifier of educationCategory
  • [EducationClassId <String>]: The unique identifier of educationClass
  • [EducationGradingCategoryId <String>]: The unique identifier of educationGradingCategory
  • [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
  • [EducationUserId <String>]: The unique identifier of educationUser

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.education/get-mgeducationclass

https://learn.microsoft.com/graph/api/educationclass-get?view=graph-rest-1.0

https://learn.microsoft.com/graph/api/educationclass-list?view=graph-rest-1.0