Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Remove-GAGroup

SYNOPSIS

Delete Group

SYNTAX

Email (Default)

Remove-GAGroup [-GroupName] <String> [-Force] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

GAGroupObject

Remove-GAGroup [-GAGroupObject] <Group> [-Force] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Delete Group

EXAMPLES

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

PS C:\> Remove-GAGroup -GroupKey $SomeGroupKeyString

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

-GroupName

Email or immutable Id of the group

Type: String
Parameter Sets: Email
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GAGroupObject

An object representing a group to remove

Type: Group
Parameter Sets: GAGroupObject
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
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

Email or immutable Id of the group

Google.Apis.admin.Directory.directory_v1.Data.Group

An object representing a group to remove

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally