-
Notifications
You must be signed in to change notification settings - Fork 10
Set GClassroomCourse
Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors.
- `NOT_FOUND` if no course exists with the requested ID.
- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.
- `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
Set-GClassroomCourse [-Id] <String> [[-CourseBody] <Course>] [[-UpdateMask] <String>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors.
- `NOT_FOUND` if no course exists with the requested ID.
- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.
- `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
PS C:\> Set-GClassroomCourse -Id $SomeIdString -CourseBody $SomeCourseObj
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 update. This identifier can be either the Classroom-assigned identifier or an alias.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Course in Classroom.
Type: Course
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseMask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
Type: String
Parameter Sets: (All)
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 update. This identifier can be either the Classroom-assigned identifier or an alias.
A Course in Classroom.
Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
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