Skip to content

Commit b2b08cf

Browse files
milanholemansAdam-it
authored andcommitted
Restructures v11 upgrade guidance. Closes #6887
1 parent 3143306 commit b2b08cf

File tree

1 file changed

+74
-89
lines changed

1 file changed

+74
-89
lines changed

docs/docs/v11-upgrade-guidance.mdx

Lines changed: 74 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ import TabItem from '@theme/TabItem';
33

44
# v11 Upgrade Guidance
55

6-
The v11 release of CLI for Microsoft 365 introduces several breaking changes. To assist you in upgrading to the latest version, we've outlined the changes and the actions you may need to take.
6+
The v11 release of CLI for Microsoft 365 introduces several breaking changes. This guide outlines those changes and the actions you may need to take to upgrade smoothly from v10 to v11.
77

88
## SharePoint Embedded
99

1010
### Updated container type commands
1111

12-
We have updated all `spe containertype` commands to use a new preview endpoint. This endpoint provides more capabilities and configuration options, enabling us to introduce additional commands for SharePoint Embedded in the future. Once Microsoft makes a stable endpoint available, we will move our commands to that version.
12+
We have updated all `spe containertype` commands to use a new preview endpoint. This endpoint offers more capabilities and configuration options, enabling us to introduce additional SharePoint Embedded commands in the future. Once Microsoft releases a stable endpoint, we will update our commands accordingly.
1313

14-
As part of this change, the options available in `spe containertype add` have been replaced with new ones. These new options allow you to configure more settings on a container type than before.
14+
As part of this change, the options available in `spe containertype add` have been replaced with new ones, allowing you to configure more container-type settings than before.
1515

16-
The only exception is the `spe containertype remove` command. Due to significant limitations in the current preview API, we decided not to update this command at this time. As a result, `spe containertype remove` requires different permissions compared to the other `spe containertype` commands. Once Microsoft addresses these limitations, we will align the command with the others.
16+
The **exception** is the `spe containertype remove` command. Due to significant limitations in the current preview API, this command has not been updated. As a result, `spe containertype remove` requires different permissions compared to other `spe containertype` commands. Once Microsoft addresses these limitations, we will align it with the rest.
1717

18-
Additionally, if you use `spe container` commands and specify the container type by name (instead of by ID), you will need to consent to different permissions on your app registration. Please refer to the documentation page for the specific command you're using to verify which permissions are required.
18+
Additionally, if you use `spe container` commands and specify the container type by name (instead of ID), you will need to consent to extra permissions in your app registration. Check the documentation for each command to verify which permissions are required.
1919

2020
**Affected commands:**
2121

22-
Commands with updated options:
22+
Commands with new options:
2323

2424
- [spe containertype add](./cmd/spe/containertype/containertype-add)
2525

@@ -36,75 +36,69 @@ Commands with updated permission scopes:
3636

3737
#### What action do I need to take?
3838

39-
Check the documentation of each of the commands above to see the updated options and permissions. If you use `spe containertype remove`, no action is needed at this time.
39+
- Review the documentation for each updated command to learn about the new options and permissions.
40+
- If you use `spe containertype remove`, no action is required at this time.
4041

4142
## SharePoint Online
4243

43-
### `spo homesite set` no longer adds new home sites
44+
### Changed default for `spo list view add` paged option
4445

45-
The [spo homesite set](./cmd/spo/homesite/homesite-set.mdx) command has been updated to only modify existing home sites. It will no longer add a new site as home site if you don't have any configured yet.
46+
The [spo list view add](./cmd/spo/list/list-view-add.mdx) command now defaults the `paged` option to `true` (previously `false`). This reflects common usage patterns, where most views support paging and fetch new items while scrolling.
4647

4748
#### What action do I need to take?
4849

49-
- **For adding new home sites**: Use the new [spo homesite add](./cmd/spo/homesite/homesite-add.mdx) command instead
50-
- **For updating existing home sites**: Continue using [spo homesite set](./cmd/spo/homesite/homesite-set.mdx) as before with required option `siteUrl`.
50+
- If you want paged views (the most common scenario), no action is required.
51+
- If you want static views, explicitly specify `--paged false`.
5152

52-
### `spo list view add` default paged option changed
53+
### Updated behavior for `spo homesite` commands
5354

54-
The [spo list view add](./cmd/spo/list/list-view-add.mdx) command has been updated to change the default value of the `paged` option from `false` to `true`. This change reflects the common usage pattern where most views allow paging and fetch new items while scrolling down.
55+
When SharePoint home sites were first introduced, only one home site was supported per tenant. Now, you can configure multiple home sites. To reflect this change, the `spo homesite` commands now require a URL to identify the specific home site.
5556

56-
#### What action do I need to take?
57-
58-
- **If you want paged views (most common)**: No action required as this is now the default behavior.
59-
- **If you want static views**: Explicitly specify `--paged false` when creating views that should not fetch new items while scrolling.
60-
61-
### Updated `homesite` commands and options
62-
63-
In the beginning when SharePoint home sites were introduced, you could only setup one single home site per tenant.
64-
Nowadays, you can have multiple home sites in your tenant.
65-
To reflect this change, we had to update our `spo homesite` commands to always require a URL to identify the home site to work with.
66-
67-
For the following commands, the `url` option is now required.
57+
Commands affected:
6858

6959
- [spo homesite get](./cmd/spo/homesite/homesite-get.mdx)
7060
- [spo homesite remove](./cmd/spo/homesite/homesite-remove.mdx)
61+
- [spo homesite set](./cmd/spo/homesite/homesite-set.mdx)
7162

72-
Additionally, the `spo homesite remove` command will not return a command output anymore. Since the command output was more informative in the past, we decided to just drop it.
63+
**Changes in detail:**
7364

74-
Due to a change in the underlying API, the command output of `spo homesite get` has also been changed. Check the documentation for the latest output format.
65+
- **spo homesite get**: The command output format has changed due to updates in the underlying API.
66+
- **spo homesite remove**: This command no longer returns output. Since the previous output was limited in value, we removed it entirely.
67+
- **spo homesite set**: This command now only updates existing home sites. It no longer adds a new home site if none are configured. Use the new `spo homesite add` command instead.
7568

7669
#### What action do I need to take?
7770

78-
Update your scripts to use the required `url` option in `spo homesite get` and `spo homesite remove` commands.
79-
Additionally, update your scripts to handle the changed output of the `spo homesite get` command and the lack of output of the `spo homesite remove` command.
71+
- Update your scripts to always include the required `url` option.
72+
- Adjust your scripts to handle the changed output of `spo homesite get` and the lack of output for `spo homesite remove`.
73+
- Use [spo homesite add](./cmd/spo/homesite/homesite-add.mdx) to add a new home site.
8074

81-
### `spo serviceprincipal grant list` command output updated
75+
### Updated output for `spo serviceprincipal grant list`
8276

83-
In order to align our commands with the latest updates done by Microsoft we had to update the API endpoint used by the [spo serviceprincipal grant list](./cmd/spo/serviceprincipal/serviceprincipal-grant-list.mdx) command. As a result, the output of this command has changed.
77+
The [spo serviceprincipal grant list](./cmd/spo/serviceprincipal/serviceprincipal-grant-list.mdx) command now uses an updated API endpoint. As a result, its output has changed.
8478

8579
#### What action do I need to take?
8680

87-
- **If you parse the output of this command**: Update your scripts to handle the new output format.
81+
Update your scripts to handle the new output format, check the command docs for the new output.
8882

89-
## SharePoint Framework
83+
## SharePoint Framework (SPFx)
9084

91-
### Updated `spfx project upgrade` commands default behavior
85+
### Updated default shell for `spfx project upgrade`
9286

93-
The [spfx project upgrade](./cmd/spfx/project/project-upgrade.mdx) command has been updated to use PowerShell as the default shell instead of bash. This change reflects the current usage patterns where PowerShell is more commonly used than bash.
87+
The [spfx project upgrade](./cmd/spfx/project/project-upgrade.mdx) command now defaults to **PowerShell** instead of Bash. This change reflects current usage trends, where most developers use PowerShell.
9488

9589
#### What action do I need to take?
9690

97-
- **If you prefer bash**: Explicitly specify the `--shell` option with `bash` value when running the command
98-
- **If you use PowerShell**: No action required as this is now the default behavior
91+
- If you prefer Bash, explicitly set `--shell bash`.
92+
- If you use PowerShell, no action is required.
9993

10094
## Teams
10195

102-
### Ensure list output for `teams report` commands
96+
### Consistent list output for `teams report` commands
10397

104-
We noticed that some of the `list` commands were not returning an array, but an object with a `value` property. We've updated those commands to return an array of items.
98+
Previously, some `teams report` commands returned an object with a `value` property instead of a direct array. We've updated them to return a proper array for consistency.
10599

106100
<details>
107-
<summary>Click here to compare the different command outputs of an affected command</summary>
101+
<summary>Click here to compare output differences</summary>
108102

109103
<Tabs>
110104
<TabItem value="v10 output">
@@ -175,7 +169,7 @@ We noticed that some of the `list` commands were not returning an array, but an
175169
</Tabs>
176170
</details>
177171

178-
The commands impacted by this change are:
172+
**Impacted commands:**
179173

180174
- [teams report directroutingcalls](./cmd/teams/report/report-directroutingcalls.mdx)
181175
- [teams report pstncalls](./cmd/teams/report/report-pstncalls.mdx)
@@ -184,74 +178,68 @@ The commands impacted by this change are:
184178

185179
Update your scripts to expect an array of items.
186180

187-
188181
## General
189182

190-
### Changed the way to retrieve default environments
183+
### Explicit option for default environments
191184

192-
We've changed how Power Platform commands retrieve default environments for consistency across our commands. Previously, some commands would return the default environment when you didn't specify any options. Now, you need to explicitly specify the `--default` option to get the default environment.
185+
We changed how Power Platform commands retrieve default environments for consistency.
186+
Previously, commands would automatically return the default environment if no options were specified.
187+
Now, you must explicitly use the `--default` option.
193188

194-
Affected commands:
189+
**Affected commands:**
195190

196-
- [pp environment get](./cmd/pp/environment/environment-get.mdx)
197-
- [flow environment get](./cmd/flow/environment/environment-get.mdx)
198-
- [pa environment get](./cmd/pa/environment/environment-get.mdx)
191+
- [pp environment get](./cmd/pp/environment/environment-get.mdx)
192+
- [flow environment get](./cmd/flow/environment/environment-get.mdx)
193+
- [pa environment get](./cmd/pa/environment/environment-get.mdx)
199194

200195
#### What action do I need to take?
201196

202-
Update your scripts to include the `--default` option when you want to retrieve the default environment.
197+
Update your scripts to include `--default` when retrieving the default environment.
203198

204-
### Ensured output for `list` commands
199+
### Consistent output for empty `list` commands
205200

206-
We noticed that some of the `list` commands were not returning any output when no items were found. We've updated all `list` commands to return an empty array when no items are found.
201+
Some `list` commands previously returned no output when no items were found. They now return an empty array (`[]`).
207202

208-
The commands impacted by this change are:
203+
**Impacted command:**
209204

210205
- [spo customaction list](./cmd/spo/customaction/customaction-list.mdx)
211206

212207
#### What action do I need to take?
213208

214-
Update your scripts to expect an empty array when no items are found.
215-
216-
### Removed aliasses
217-
218-
We've removed some aliasses to streamline the command set and avoid confusion. The following aliasses have been removed:
219-
220-
- `pp chatbot get` is now [pp copilot get](./cmd/pp/copilot/copilot-get.mdx)
221-
- `pp chatbot list` is now [pp copilot list](./cmd/pp/copilot/copilot-list.mdx)
222-
- `pp chatbot remove` is now [pp copilot remove](./cmd/pp/copilot/copilot-remove.mdx)
223-
- `spo tenant homesite list` is now [spo homesite list](./cmd/spo/homesite/homesite-list.mdx)
224-
225-
#### What action do I need to take?
226-
227-
Update any `pp chatbot` and `spo tenant homesite` references in your scripts to `pp copilot` and `spo homesite` for compatibility.
209+
- Update your scripts to handle an empty array when no results are found.
228210

229211
### Removed commands
230212

231-
Some commands were removed because their API endpoint became deprecated or the product began an end-of-life phase.
232-
233-
Read the documentation for alternative commands to find out how to use them and what permissions are required.
213+
We removed some commands due to deprecated APIs or product end-of-life.
234214

235215
Command | Alternative
236-
--- | ---
237-
`pp card clone` | None
238-
`pp card get` | None
239-
`pp card list` | None
240-
`pp card remove` | None
216+
------- | -----------
217+
`pp card clone` | None (product is end-of-life)
218+
`pp card get` | None (product is end-of-life)
219+
`pp card list` | None (product is end-of-life)
220+
`pp card remove` | None (product is end-of-life)
241221
`spo mail send` | [outlook mail send](./cmd/outlook/mail/mail-send.mdx)
242-
`skype report activitycounts` | None
243-
`skype report activityusercounts` | None
244-
`skype report activityuserdetail` | None
222+
`skype report activitycounts` | None (product is end-of-life)
223+
`skype report activityusercounts` | None (product is end-of-life)
224+
`skype report activityuserdetail` | None (product is end-of-life)
245225
`viva engage group list` | [viva engage community list](./cmd/viva/engage/engage-community-list.mdx)
246226
`viva engage group user add` | [viva engage community user add](./cmd/viva/engage/engage-community-user-add.mdx)
247227
`viva engage group user remove` | [viva engage community user remove](./cmd/viva/engage/engage-community-user-remove.mdx)
248228

249-
### Aligned command names
229+
#### What action do I need to take?
230+
231+
Update your scripts to use the alternative commands, if available.
250232

251-
Some command names have been updated to reflect the latest Microsoft 365 terminology. Additionally, command improvements sometimes lead to renaming for better functionality alignment.
233+
### Renamed commands for alignment
234+
235+
We renamed some commands to align with the latest Microsoft 365 terminology and to better reflect functionality.
252236

253237
v10 command | v11 command
254-
--- | ---
238+
----------- | -----------
239+
`pp chatbot get` | [pp copilot get](./cmd/pp/copilot/copilot-get.mdx)
240+
`pp chatbot list` | [pp copilot list](./cmd/pp/copilot/copilot-list.mdx)
241+
`pp chatbot remove` | [pp copilot remove](./cmd/pp/copilot/copilot-remove.mdx)
242+
`spo tenant homesite list` | [spo homesite list](./cmd/spo/homesite/homesite-list.mdx)
255243
`spo tenant site archive` | [spo site archive](./cmd/spo/site/site-archive.mdx)
256244
`spo tenant site list` | [spo site list](./cmd/spo/site/site-list.mdx)
257245
`spo tenant site membership list` | [spo site membership list](./cmd/spo/site/site-membership-list.mdx)
@@ -260,14 +248,11 @@ v10 command | v11 command
260248

261249
#### What action do I need to take?
262250

263-
Update your scripts to use the new command names listed.
264-
265-
### Aligned naming options
251+
Update your scripts to use the new command names.
266252

267-
Just like with command names, we also have to rename options to reflect the changes in the product. We also try to make the options more descriptive and clearer to make it easier for you to use the CLI.
268-
These changes aim to make it easier for you to use the CLI.
253+
### Renamed options for clarity
269254

270-
We've updated the following options:
255+
We also renamed some options to reflect product changes and make them more descriptive.
271256

272257
Command | Old option | New option
273258
------- | ---------- | ----------
@@ -286,8 +271,8 @@ Command | Old option | New option
286271
[pp solution publisher list](./cmd/pp/solution/solution-publisher-list.mdx) | `includeMicrosoftPublishers` | `withMicrosoftPublishers`
287272
[purview threatassessment get](./cmd/purview/threatassessment/threatassessment-get.mdx) | `includeResults` | `withResults`
288273
[spo file move](./cmd/spo/file/file-move.mdx) | `includeItemPermissions` | `withItemPermissions`
289-
[spo homesite add](./cmd/spo/homesite/homesite-add.mdx) | `audiences ` | `audienceIds`
290-
[spo homesite set](./cmd/spo/homesite/homesite-set.mdx) | `siteUrl ` | `url`
274+
[spo homesite add](./cmd/spo/homesite/homesite-add.mdx) | `audiences` | `audienceIds`
275+
[spo homesite set](./cmd/spo/homesite/homesite-set.mdx) | `siteUrl` | `url`
291276
[spo hubsite get](./cmd/spo/hubsite/hubsite-get.mdx) | `includeAssociatedSites` | `withAssociatedSites`
292277
[spo hubsite list](./cmd/spo/hubsite/hubsite-list.mdx) | `includeAssociatedSites` | `withAssociatedSites`
293278
[spo site list](./cmd/spo/site/site-list.mdx) | `includeOneDriveSites` | `withOneDriveSites`
@@ -297,4 +282,4 @@ Command | Old option | New option
297282

298283
#### What action do I need to take?
299284

300-
If you use any of the commands listed above, ensure that you use the new option names.
285+
If you use any of these commands, update your scripts to reflect the new option names.

0 commit comments

Comments
 (0)