Get-EasyGuestUser
SYNOPSIS
Get EasyLife guest user accounts from the Graph API.
SYNTAX
byDisplayName (Default)
Get-EasyGuestUser [-DisplayName <String>] [-Top <Int32>] [-PropertySet <Object>] [<CommonParameters>]
byId
Get-EasyGuestUser [-Id <String>] [-PropertySet <Object>] [<CommonParameters>]
all
Get-EasyGuestUser [-Top <Int32>] [-All] [-PropertySet <Object>] [<CommonParameters>]
DESCRIPTION
This function uses Get-MgUser to retrieve guest user accounts from the Graph API. It expands properties relevant to EasyLife such as owners and metadata.
EXAMPLES
EXAMPLE 1
Get-EasyGuestUser
This example returns up to 100 guest user accounts and their properties.
EXAMPLE 2
Get-EasyGuestUser -All
This example returns all guest user accounts and their properties.
EXAMPLE 3
Get-EasyGuestUser -Top 3
This example returns 3 guest user accounts and their properties.
EXAMPLE 4
Get-EasyGuestUser -DisplayName Thomas
This example returns all guest user accounts that have a DisplayName that starts with Thomas.
EXAMPLE 5
Get-EasyGuestUser -All -PropertySet Minimum
This example returns all guest user accounts with a minimum set of attributes that can be retrieved quickly. The resulting objects will contain the owner's object id instead of the owner's user principal name.
PARAMETERS
-Id
Use this parameter to retrieve a guest user account with the specified Id.
Type: String
Parameter Sets: byId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayName
Use this parameter to retrieve guest user accounts that have a DisplayName that starts with the given value.
Type: String
Parameter Sets: byDisplayName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Top
Use this parameter to retrieve the specified number of guest user accounts.
Type: Int32
Parameter Sets: byDisplayName, all
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-All
Use this parameter to retrieve all guest user accounts.
Type: SwitchParameter
Parameter Sets: all
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PropertySet
Use this parameter to select a set of attributes to be retrieved from the Graph API. This can be useful for automation or when dealing with a large number of objects. Currently, the only available set is Minimum.
Type: Object
Parameter Sets: (All)
Aliases:
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.
INPUTS
None
You cannot pipe values to this cmdlet.
OUTPUTS
[ELGuestUser]
This function returns object of the type ELGuestUser.
NOTES
None.
RELATED LINKS
https://docs.easylife365.cloud/docs/add-ons/powershell/get-easyguestuser/