Logo

Documentation home for Transend tools

  • Export-M365Applications
  • Export-M365DirectoryObjects
  • Export-M365Domains
  • Export-M365Groups
  • Export-M365Mailboxes
  • Export-M365OrgLicenses
  • Export-M365OrgUnits
  • Export-M365Resources
  • Export-M365SharedContacts
  • Export-M365SharedDrives
  • Export-M365SharedMailboxes
  • Export-M365Sites
  • Export-M365Users
  • Import-M365Groups
  • Import-M365Resources
  • Import-M365SharedContacts
  • Import-M365SharedMailboxes
  • Import-M365Sites
  • Import-M365UserDrives
  • Import-M365Users
  • Register-M365App
  • Update-M365Groups
  • Update-M365Resources
  • Update-M365SharedContacts
  • Update-M365SharedMailboxes
  • Update-M365Users

    • Home

    Export-M365Mailboxes

    SYNOPSIS

    Exports mailboxes from a Microsoft 365 tenant.

    SYNTAX

    Help (Default)

    Export-M365Mailboxes [-ShowPrereqs] [<CommonParameters>]

    Action

    Export-M365Mailboxes -ConfigNode <String> [-Target <String>] [-Format <String>]
 [<CommonParameters>]

    DESCRIPTION

    Use the Export-M365Mailboxes cmdlet to export mailboxes from a Microsoft 365 tenant.

    See the Notes section for cmdlet requirements.

    EXAMPLES

    Example 1: Export raw data

    Export-M365Mailboxes -ConfigNode Source -Format Csv >'mailboxes.csv'

    This example exports all mailboxes from a Microsoft 365 tenant. The exported data is formatted as CSV and saved to the file mailboxes.csv.

    PARAMETERS

    -ConfigNode

    The config.psd1 configuration node to use.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

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

    -Format

    The output type for exported data.

    Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

Required: False
Position: Named
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

    -ShowPrereqs

    Prints the cmdlet prerequisites.

    Type: SwitchParameter
Parameter Sets: Help
Aliases:

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

    -Target

    Specifies a mapping target for the exported data. Exported data mapped for a supported target is directly consumable by a corresponding import cmdlet.

    To export unmapped data, use -Target None.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: None

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

    OUTPUTS

    System.Object[]

    NOTES

    Required PowerShell modules

    • ExchangeOnlineManagement
    • Microsoft.Online.SharePoint.PowerShell
    • PnP.PowerShell

    Note that you must install the Microsoft.Online.SharePoint.PowerShell module using Windows PowerShell (PowerShell 5.1 or earlier).

    Required config.psd1 configurations

    • M365ClientId
    • M365ClientSecret
    • M365SharePointDomain
    • M365Tenant

    Optional config.psd1 configurations

    • M365ClientCertificate
    • M365CloudEnvironment

    Required APIs

    • Microsoft Graph
    • Office 365 Exchange Online
    • SharePoint

    Required Microsoft Graph Application scopes

    • Calendars.Read
    • Directory.Read.All
    • Sites.Read.All

    Required Office 365 Exchange Online Application scopes

    • Exchange.ManageAsApp

    Required SharePoint Application scopes

    • Sites.FullControl.All

    TMCTools configuration options