Microsoft 365 Initialize Archives script

Use m365_initialize_archives.ps1 when the migration includes online archive mailboxes. The script enables an archive for each selected user whose archive is not already active, ensuring that the archive exists before Transend Migration Console attempts to migrate archive content. By default it processes all users with mailboxes; use -Csv to limit the change to the users in the migration.

The script records each archive it enables in m365_restore_archives.json in your Documents directory. Keep this file if you may need to undo the changes. Running m365_restore_archives.ps1 from the same user account uses that record to disable only the archives enabled by the initialize script. Disabling archives is normally unnecessary and may affect access to archived content, so restore them only when your migration plan specifically requires it.

Setup

Download TMCTools.
From the TMCTools zip file, extract common.psm1, m365.psm1 and m365_initialize_archives.ps1 from the TMCTools/bin folder.
Ensure you have created the required app using m365_initialize_app.ps1.

Usage

.\m365_initialize_archives.ps1
  -AppId <AppId>
  -AppSecret <AppSecret>
  -TenantId <TenantId>
  [-Csv <Csv>]
  [-CloudEnvironment <Default | DoD | GCCHigh | China | Germany>]

Parameters

Parameter	Required	Values	Description
`-AppId`	Yes	App ID	The application ID to use for authentication.
`-AppSecret`	Yes	App secret	The application secret to use for authentication.
`-TenantId`	Yes	Tenant identifier	The tenant ID to connect to.
`-Csv`	No	Path to a CSV file	A CSV file containing a list of objects to process.
`-CloudEnvironment`	No	`Default`, `DoD`, `GCCHigh`, `China`, `Germany`	The cloud environment to connect to. Use this option if your tenant is not in the worldwide cloud.

Examples

Example 1: Configure all users for archive migration

.\m365_initialize_archives.ps1 -AppId '8b26caf2-2ef6-4a9d-9c27-98616d1c1294' -AppSecret '9pitRZoTezs6M0b~bgcibEfkG6qMaczuNV25Ol6m' -TenantId 'example.org'

Example 2: Configure select users for archive migration

To limit the users for which archives will be configured, you’ll need to create a CSV with a single field named Identity that includes any of the following attributes:

ID
UPN
Email address
Display name

For example:

Identity
user1@example.org
user2@example.org
user3@example.org

.\m365_initialize_archives.ps1 -AppId '8b26caf2-2ef6-4a9d-9c27-98616d1c1294' -AppSecret '9pitRZoTezs6M0b~bgcibEfkG6qMaczuNV25Ol6m' -TenantId 'example.org' -Csv 'C:\Temp\users.csv'

Troubleshooting

Review the log file in your Documents directory for more information.