Get-MtUser

SYNOPSIS

Get a list of users from the tenant

SYNTAX

Get-MtUser [[-Count] <Int32>] [[-UserType] <String>] [[-MemberOfRole] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function retrieves a list of users from the tenant. You can specify the number of users to retrieve, the type of users (Member, Guest, Admin) and the role the users are member of.

EXAMPLES

EXAMPLE 1

Get-MtUser -Count 5 -UserType Member
# Get 5 Member users from the tenant.

PARAMETERS

-Count

The number of users to retrieve. Default is 1.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-UserType

The type of users to retrieve. Default is Member. Valid values are Member, Guest, Admin.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Member
Accept pipeline input: False
Accept wildcard characters: False

-MemberOfRole

The role the users are member of. Default is None. Valid values are Global Administrator, Application Administrator, Authentication Administrator, Billing Administrator, Cloud Application Administrator, Conditional Access Administrator, Exchange Administrator, Helpdesk Administrator, Password Administrator, Privileged Authentication Administrator, Privileged Role Administrator, Security Administrator, SharePoint Administrator, User Administrator.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

OUTPUTS

System.Collections.ArrayList

NOTES

RELATED LINKS

https://maester.dev/docs/commands/Get-MtUser