Remove-GSStudentGuardian¶
SYNOPSIS¶
Removes a guardian.
SYNTAX¶
Remove-GSStudentGuardian [-StudentId] <String> [-GuardianId] <String> [[-User] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Removes a guardian.
EXAMPLES¶
EXAMPLE 1¶
Remove-GSStudentGuardian -StudentId [email protected] -GuardianId $guardianId
Removes the guardian for [email protected].
PARAMETERS¶
-GuardianId¶
The id field from a Guardian.
Type: String Parameter Sets: (All) Aliases: Guardian Required: True Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-StudentId¶
The identifier of the student to get guardian info for. 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: (All) Aliases: Student Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-User¶
The user to authenticate the request as
Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $Script:PSGSuite.AdminEmail Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter Parameter Sets: (All) Aliases: cf Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter Parameter Sets: (All) Aliases: wi Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.