Skip to content

New GClassroomGuardianObj

Spencer Varney edited this page Dec 9, 2016 · 2 revisions

New-GClassroomGuardianObj

SYNOPSIS

Creates a new Classroom API Guardian object.

SYNTAX

New-GClassroomGuardianObj [[-GuardianId] <String>] [[-GuardianProfile] <UserProfile>]
 [[-InvitedEmailAddress] <String>] [[-StudentId] <String>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a Guardian 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.Guardian

EXAMPLES

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

PS C:\> New-GClassroomGuardianObj

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

-GuardianId

Identifier for the guardian.

Type: String
Parameter Sets: (All)
Aliases: 

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

-GuardianProfile

User profile for the guardian.

Type: UserProfile
Parameter Sets: (All)
Aliases: 

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

-InvitedEmailAddress

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

Type: String
Parameter Sets: (All)
Aliases: 

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

-StudentId

Identifier for the student to whom the guardian relationship applies.

Type: String
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.String

Identifier for the guardian.

Google.Apis.Classroom.v1.Data.UserProfile

User profile for the guardian.

System.String

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

System.String

Identifier for the student to whom the guardian relationship applies.

OUTPUTS

Google.Apis.Classroom.v1.Data.Guardian

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]

Clone this wiki locally