CLI for Microsoft 365 v6.4
We’ve published a new minor version of CLI for Microsoft 365.
CLI for Microsoft 365 is a cross-platform tool. It helps you manage your Microsoft 365 tenant and SharePoint Framework projects. No matter which operating system or shell you use.
Read the release notes in full for all new features and improvements.
We’ve added new commands in this release. This section gives an overview of the new functionality.
Rosters are a new type of container that you can use to manage access to Planner plans without the need for a Microsoft 365 group.
To retrieve a specific user by their user name from a given roster, use:
m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName email@example.com
Flows in Power Automate let you share your flows with others as owners or users. Owners can change flows, whereas users can run or execute flows.
We’ve released three new commands in this release to manage the ownership of Power Automate Flows.
To list the owners of a Power Automate Flow created by another user by its name, use:
m365 flow owner list --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
To add a new user as an owner of a Power Automate Flow by their username, use:
m365 flow owner ensure --userName "firstname.lastname@example.org" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
To remove a user as an owner of a Power Automate Flow by their username, use:
m365 flow owner remove --userName email@example.com --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72
Also to add specific users, we’ve included support for adding a group as an owner.
To add a group as an owner of a Power Automate Flow by its id, use:
m365 flow owner ensure --groupId 8d4d9f32-1ab0-4f81-9054-efbb1759e8e6 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
To remove a group as an owner of a Power Automate Flow by its id, use:
m365 flow owner remove --groupId "5c241023-2ba5-4ea8-a516-a2481a3e6c51" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --name 72f2be4a-78c1-4220-a048-dbf557296a72
When you keep content, the retention period is often based on the age of the content. For example, you might keep documents for seven years after they’re created and then delete them. when you configure retention labels, you can also base a retention period on when a specific type of event occurs. The event triggers the start of the retention period. All content with a retention label applied for that type of event get the label’s retention actions enforced on them.
We’ve added a new command in this release to create new retention events to trigger the start of a retention period.
To create a retention event to start retention at the end of 2022 for all employee documents that have a label and have the Asset ID
m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventType 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
SharePoint Online Tenant Application Customizers are a type of SharePoint Framework (SPFx) extension. They allow developers to add custom scripts or HTML to the header or footer of every page in a SharePoint site collection. A tenant scoped customization applies to all sites and subsites within the tenant.
To retrieve a tenant scoped Application Customizer by its title, use:
m365 spo tenant applicationcustomizer get --title 'Some customizer'
When attempting to add a user to a SharePoint Online site that is already a member you will receive an error.
We’ve added a new command in this release to check whether the specified user name is a member of the site. If the user is not a member of the site, it adds it as a member.
To ensure a user on a site, use:
m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --userName firstname.lastname@example.org
ListView Command Sets are a feature in SharePoint Online that allows you to add custom actions to the command bar in a list or library.
We’ve added four new commands to this release to manage ListView Command Sets on SharePoint Online sites.
To remove a ListView Command Set by its title on a specified SharePoint Online site, use:
m365 spo commandset remove --title 'Some customizer' --webUrl https://contoso.sharepoint.com/sites/sales
To update the title and location of a ListView Command Set Updates the title and location of a ListView Command Set on the sales site.
m365 spo commandset set --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --newTitle 'Some new title' --location Both --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
To retrieve a ListView Command Set by its title from a SharePoint Online site, use:
m365 spo commandset get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
To retrieve a list of ListView Command Sets from a SharePoint Online site, use:
m365 spo commandset list --webUrl https://contoso.sharepoint.com/sites/sales
To add a ListView Command Set to a list on a SharePoint Online site, use:
m365 spo commandset add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --listType List --webUrl https://contoso.sharepoint.com/sites/sales
We’ve updated some existing commands with new functionality. Here is an overview of the new functionality.
In this release we’ve made an internal change to our existing Power Platform commands.
The change does not change any of the command options, however it does introduce an additional permission that you may need to consent to.
If you have scripts that are using Power Platform commands and they stop working, it is highly likely that it will be due to this change.
To resolve the issue, you need to consent to the additional permission, PowerApps Service, that has been added to the PnP Management Shell Azure AD application.
To review and re-consent CLI for Microsoft 365 permissions, use:
m365 cli reconsent
Read the pull request for more details on this change.
SharePoint Online supports the ability to create navigation nodes called Labels that don’t need you to provide a URL.
We’ve updated the
spo navigation node add command to support the creation of Label navigation nodes.
To create a label (or linkless navigation node), use:
m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar --title About
flow run list command only returned runs for Flows that were created by the logged in user.
In this release, we’ve extended the command to support returning runs for Flows created by other users with an
To list Power Automate Flow runs for a flow created by another user, use:
m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --asAdmin
The Microsoft Graph endpoint that we use for creating tasks has been updated with new properties.
In this release we have extended the
todo task add command with new options:
- Start Date Time
- Completed Date Time
To create a new task, setting categories, a completed date and time, a start date and Time and a task status, use:
m365 todo task add --title "New task" --listName "My task list" --categories "Red category,Important" --completedDateTime 2023-12-01 --startDateTime 2023-12-01 --status "notStarted"
In this release we have extended the
spo homesite set command to now give the ability to turn on or off the Viva Connections start experience.
To turn on the Viva Connections start experience on a SharePoint Online Home Site, use:
m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms --vivaConnectionsDefaultStart $true
In this release we’ve updated the
spfx project upgrade command to provide support for upgrading your projects to the latest preview version of SharePoint Framework.
To upgrade your project to the latest preview version, use:
m365 spfx project upgrade --preview
Here are some things that we are currently working on.
We are always looking to add more commands to CLI for Microsoft 365.
We are busy implementing commands across several Microsoft 365 services, such as Power Platform, SharePoint Online and Microsoft Purview.
We recently launched a community Discord server for CLI for Microsoft 365.
We’ve seen a huge amount of engagement and activity on the server. So much so, that we’ve decided to make it where we want to focus and grow the CLI for Microsoft 365 community.
We’ve made it easier for you to get help, share and find content related to CLI for Microsoft 365.
- Have a question about CLI for Microsoft 365? Create a thread in the
- Have you seen or created an article related to CLI for Microsoft 365? Share it in the
- Have you seen or created a video related to CLI for Microsoft 365? Share it in the
- Want to have chat about CLI for Microsoft 365? Use the
We are looking at other ways in which we can use Discord. So expect to see a lot more changes and activity over the coming months.
If you aren’t already a member, join today: aka.ms/cli-m365/discord
If you are, thank you for being an amazing part of this community.
This release wouldn’t be possible without the help of (in alphabetical order):
- Adam Wójcik
- Garry Trinder
- Jasey Waegebaert
- Martin Lingstuyl
- Mathijs Verbeeck
- Milan Holemans
- Nanddeep Nachan
- Nico De Cleyre
- Reshmee Auckloo
- Smita Nachan
- Valeras Narbutas
- Waldek Mastykarz
Thank you all for the time you chose to spend on CLI for Microsoft 365 and for your help to advance it!
Get the latest release of CLI for Microsoft 365 from npm by executing:
npm i -g @pnp/cli-microsoft365
Or, you can get the latest release from Docker by executing:
docker run --rm -it m365pnp/cli-microsoft365:latest
If you need more help getting started or want more details about the commands, architecture, or project, go to aka.ms/cli-m365.