-
Notifications
You must be signed in to change notification settings - Fork 10
New GClassroomCourseObj
Creates a new Classroom API Course object.
New-GClassroomCourseObj [[-AlternateLink] <String>] [[-CourseGroupEmail] <String>]
[[-CourseMaterialSets] <CourseMaterialSet[]>] [[-CourseState] <String>] [[-CreationTime] <String>]
[[-Description] <String>] [[-DescriptionHeading] <String>] [[-EnrollmentCode] <String>]
[[-GuardiansEnabled] <Boolean>] [[-Id] <String>] [[-Name] <String>] [[-OwnerId] <String>] [[-Room] <String>]
[[-Section] <String>] [[-TeacherFolder] <DriveFolder>] [[-TeacherGroupEmail] <String>]
[[-UpdateTime] <String>] [-WhatIf] [-Confirm]
This provides a Cmdlet-Based approach to creating a Course object which may be required as a parameter for some other Cmdlets in the Classroom API category.
You could alternately create this object by calling New-Object -TypeName Google.Apis.Classroom.v1.Data.Course
PS C:\> New-GClassroomCourseObj
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.
Absolute link to this course in the Classroom web UI. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSets of materials that appear on the "about" page of this course. Read-only.
Type: CourseMaterialSet[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseState of the course. If unspecified, the default state is `PROVISIONED`.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseCreation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOptional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOptional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseEnrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether or not guardian notifications are enabled for this course. Read-only.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIdentifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOptional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSection of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseInformation about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
Type: DriveFolder
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseTime of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseAbsolute link to this course in the Classroom web UI. Read-only.
The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
Sets of materials that appear on the "about" page of this course. Read-only.
State of the course. If unspecified, the default state is `PROVISIONED`.
Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
Whether or not guardian notifications are enabled for this course. Read-only.
Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
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