Installation

Install the Microsoft-Extractor-Suite toolkit:

Install-Module -Name Microsoft-Extractor-Suite

Install the Powershell module Microsoft.Graph for the Graph API Beta functionalities:

Install-module -name Microsoft.Graph

Install the Powershell module ExchangeOnlineManagement for the Microsoft 365 functionalities:

Install-module -name ExchangeOnlineManagement

Install the Powershell module Az for the Azure Activity log functionality:

Install-module -name Az

Install the Powershell module AzureADPreview for the Azure Active Directory functionalities:

Install-Module -Name AzureADPreview

Note

If you receive an error message indicating that the specified commands already exist on your system, you can resolve the issue by including the “-AllowClobber” parameter in the “Install-Module” command. This parameter will allow the installation process to overwrite any existing versions of the module and replace them with the newer version.

Install the Powershell module Graph Beta module for the Azure Active Directory sign-in log:

Install-Module Microsoft.Graph.Beta

Note

Due to known issues with PowerShellGet for PowerShell version 5.1, the Microsoft.Graph.Beta commandlet may take a long time to install. Using the following command will upgrade PowerShellGet to the latest beta, which fixes this issue on Windows 11. For Windows 10, you may need to install the PowerShellGet module with -allowclobber prior.

Install-Module PowerShellGet -Force -AllowPrerelease

Use Connect-GraphAPI to sign in with the required scopes. The first time you’ll need to sign in with an admin account to consent to the required scopes.

Getting Started

To get started with the Microsoft-Extractor-Suite tool, make sure the requirements are met.

The first step is to import or install the Microsoft-Extractor-Suite.

To import the Microsoft-Extractor-Suite:

Import-Module .\Microsoft-Extractor-Suite.psd1

To install the Microsoft-Extractor-Suite:

Install-Module -Name Microsoft-Extractor-Suite

Additionally, you must sign-in to Microsoft 365 or Azure depending on your usage before Microsoft-Extractor-Suite functions are made available. We made a graphic to help you decide which Connect function you should use depening on what you wan to acquire.

../_images/Microsoft-Extractor-Suite-Connect.png

To sign in, use the following cmdlets:

Connect-M365
Connect-Azure
Connect-AzureAZ