-
Notifications
You must be signed in to change notification settings - Fork 10
Get GClassroomCourse
Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors.
- `NOT_FOUND` if no course exists with the requested ID.
Get-GClassroomCourse [-Id] <String> [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>]
[-WhatIf] [-Confirm]
Get-GClassroomCourse [-All] [[-StudentId] <String>] [[-TeacherId] <String>] [[-PageSize] <Int32>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors.
- `NOT_FOUND` if no course exists with the requested ID.
PS C:\> Get-GClassroomCourse -Id $SomeIdString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
PS C:\> Get-GClassroomCourse -All
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
Type: String
Parameter Sets: one
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA switch to list all results
Type: SwitchParameter
Parameter Sets: list
Aliases:
Required: True
Position: 0
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseRestricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseRestricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Type: Int32
Parameter Sets: list
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseIdentifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads