Ready to get started?

Download a free trial of the Microsoft Planner Cmdlets to get started:

 Download Now

Learn more:

Microsoft Planner Icon Microsoft Planner Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Microsoft Planner. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

PowerShell Scripting to Replicate Microsoft Planner Data to MySQL

Write a simple PowerShell script to replicate Microsoft Planner data to a MySQL database.

The CData Cmdlets for Microsoft Planner offer live access to Microsoft Planner data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Microsoft Planner and the CData Cmdlets for MySQL in PowerShell to replicate Microsoft Planner data to a MySQL database.

After obtaining the needed connection properties, accessing Microsoft Planner data in PowerShell and preparing for replication consists of four basic steps.

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Collecting Microsoft Planner Data

  1. Install the module:

    Install-Module MicrosoftPlannerCmdlets
  2. Connect to Microsoft Planner:

    $microsoftplanner = Connect-MicrosoftPlanner -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-MicrosoftPlanner -Connection $microsoftplanner -Table "Tasks"

    You can also use the Invoke-MicrosoftPlanner cmdlet to execute pure SQL-92 statements:

    $data = Invoke-MicrosoftPlanner -Connection $microsoftplanner -Query 'SELECT * FROM Tasks WHERE TaskId = @TaskId' -Params @{'@TaskId'='BCrvyMoiLEafem-3RxIESmUAHbLK'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting Microsoft Planner Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the Microsoft Planner data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Microsoft Planner resource (Tasks) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tasks" -Columns $columns -Values $values }

You have now replicated your Microsoft Planner data to a MySQL database. This gives you freedom to work with Microsoft Planner data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.


  • Once you have connected to Microsoft Planner and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-MicrosoftPlanner -Connection $microsoftplanner -Table "Tasks" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tasks" -Columns $columns -Values $values }
  • If you wish to replicate the Microsoft Planner data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-MicrosoftPlanner cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}