Remove GClassroomCourse

Remove-GClassroomCourse

SYNOPSIS

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors.

• `NOT_FOUND` if no course exists with the requested ID.

SYNTAX

Remove-GClassroomCourse [-Id] <String> [-Force] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors.

• `NOT_FOUND` if no course exists with the requested ID.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Remove-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.

PARAMETERS

-Id

Identifier of the course to delete. 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: False

-Force

A switch to run the cmdlet without prompting

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

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

-GAuthId

The 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: False

INPUTS

System.String

Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]