Pipe Microsoft Planner Data to CSV in PowerShell

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.

Use standard PowerShell cmdlets to access Microsoft Planner tables.

The CData Cmdlets Module for Microsoft Planner is a standard PowerShell module offering straightforward integration with Microsoft Planner. Below, you will find examples of using our MicrosoftPlanner Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Microsoft Planner Data

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.

$conn = Connect-MicrosoftPlanner  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Selecting Data

Follow the steps below to retrieve data from the Tasks table and pipe the result into to a CSV file:

Select-MicrosoftPlanner -Connection $conn -Table Tasks | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTasksData.csv -NoTypeInformation

You will notice that we piped the results from Select-MicrosoftPlanner into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-MicrosoftPlanner -Connection $conn -Table Tasks -Where "TaskId = BCrvyMoiLEafem-3RxIESmUAHbLK" | Remove-MicrosoftPlanner

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Microsoft Planner, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyTasksUpdates.csv | %{
  $record = Select-MicrosoftPlanner -Connection $MicrosoftPlanner -Table Tasks -Where ("Id = `'"+$_.Id+"`'")
    Update-MicrosoftPlanner -Connection $microsoftplanner -Table Tasks -Columns ("TaskId","startDateTime") -Values ($_.TaskId, $_.startDateTime) -Where ("Id = `'"+$_.Id+"`'")
    Add-MicrosoftPlanner -Connection $microsoftplanner -Table Tasks -Columns ("TaskId","startDateTime") -Values ($_.TaskId, $_.startDateTime)

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!