Cmdlets for OneNote

Build 21.0.7930

Getting Started

Connecting to OneNote

Establishing a Connection shows how to authenticate to OneNote and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for OneNote provides a familiar way to interact with OneNote from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with OneNote using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-OneNote cmdlet. You can then pass the OneNoteConnection object returned to other cmdlets for accessing data:

  • Select-OneNote
  • Add-OneNote

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-OneNote cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

OneNote Version Support

All hosted versions of OneNote are supported via the microsoft Graph API v1.0. Includes information accessible from a user's OneNote notebooks, sections, and pages in a personal or organization account.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930