@pnp/cli-microsoft365 6.0.0-beta.845d3c1 → 6.0.0-beta.9dde439

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/dist/Command.js +16 -2
  2. package/dist/m365/aad/commands/app/app-list.js +38 -0
  3. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  4. package/dist/m365/aad/commands.js +2 -0
  5. package/dist/m365/commands/status.js +6 -1
  6. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  7. package/dist/m365/outlook/commands.js +1 -0
  8. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  9. package/dist/m365/pp/commands.js +1 -0
  10. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  11. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  12. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  13. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  14. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  15. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  16. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  22. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  23. package/dist/m365/spfx/commands/project/project-upgrade.js +5 -2
  24. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  25. package/dist/m365/spo/commands/field/field-add.js +26 -1
  26. package/dist/m365/spo/commands/field/field-set.js +23 -13
  27. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  28. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  29. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  30. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  31. package/dist/m365/spo/commands/list/list-view-field-add.js +19 -5
  32. package/dist/m365/spo/commands/list/list-view-field-remove.js +18 -4
  33. package/dist/m365/spo/commands/list/list-view-field-set.js +18 -4
  34. package/dist/m365/spo/commands/list/list-view-list.js +14 -10
  35. package/dist/m365/spo/commands/list/list-view-remove.js +17 -8
  36. package/dist/m365/spo/commands/list/list-view-set.js +19 -7
  37. package/dist/m365/spo/commands/list/list-webhook-get.js +2 -3
  38. package/dist/m365/spo/commands/list/list-webhook-set.js +11 -12
  39. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  40. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  41. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  42. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  43. package/dist/m365/spo/commands/listitem/listitem-list.js +21 -11
  44. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  45. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  46. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  47. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  48. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  49. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  50. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  51. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  52. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  53. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  54. package/dist/m365/spo/commands.js +4 -2
  55. package/dist/m365/teams/commands/channel/channel-get.js +2 -2
  56. package/dist/m365/teams/commands/channel/channel-remove.js +56 -39
  57. package/dist/m365/teams/commands/channel/channel-set.js +57 -19
  58. package/dist/m365/todo/commands/list/list-get.js +89 -0
  59. package/dist/m365/todo/commands/task/task-get.js +108 -0
  60. package/dist/m365/todo/commands.js +2 -0
  61. package/dist/utils/md.js +8 -1
  62. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  63. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  64. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +3 -0
  65. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  66. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  67. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  68. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  69. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  70. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  71. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  72. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  73. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  74. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  75. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  76. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  77. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  78. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  79. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  80. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  81. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  82. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  83. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  84. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  85. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  86. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  87. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  88. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  89. package/docs/docs/cmd/spo/list/list-view-field-add.md +14 -4
  90. package/docs/docs/cmd/spo/list/list-view-field-remove.md +11 -2
  91. package/docs/docs/cmd/spo/list/list-view-field-set.md +18 -2
  92. package/docs/docs/cmd/spo/list/list-view-list.md +16 -7
  93. package/docs/docs/cmd/spo/list/list-view-remove.md +12 -3
  94. package/docs/docs/cmd/spo/list/list-view-set.md +20 -6
  95. package/docs/docs/cmd/spo/list/list-webhook-get.md +1 -1
  96. package/docs/docs/cmd/spo/list/list-webhook-set.md +11 -4
  97. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  98. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  99. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  100. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  101. package/docs/docs/cmd/spo/listitem/listitem-list.md +10 -1
  102. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  103. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  104. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  105. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  106. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  107. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  108. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  109. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +5 -10
  110. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  111. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  112. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  113. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  114. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  115. package/docs/docs/cmd/teams/channel/channel-get.md +7 -7
  116. package/docs/docs/cmd/teams/channel/channel-remove.md +12 -9
  117. package/docs/docs/cmd/teams/channel/channel-set.md +13 -6
  118. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  119. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  120. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  121. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  122. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  123. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  124. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  125. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  126. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  127. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  128. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  129. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  130. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  131. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  132. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  133. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  134. package/package.json +10 -6
@@ -14,10 +14,13 @@ m365 spo list view set [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to update. Specify `title` or `id` but not both
@@ -33,6 +36,9 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
33
36
 
34
37
  When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `&lt;` instead of `<`.
35
38
 
39
+ !!! warning "Escaping JSON in PowerShell"
40
+ When updating list view formatting for a view with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
41
+
36
42
  ## Examples
37
43
 
38
44
  Update the title of the list view specified by its name
@@ -44,11 +50,19 @@ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x -
44
50
  Update the title of the list view specified by its ID
45
51
 
46
52
  ```sh
47
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
53
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'All events'
48
54
  ```
49
55
 
50
56
  Update view formatting of the specified list view
51
57
 
52
- ```sh
53
- m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'All items' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json","additionalRowClass": "=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')"}`'
54
- ```
58
+ === "PowerShell"
59
+
60
+ ```sh
61
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter '{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, ''sp-field-severity--severeWarning'', '''')\"}'
62
+ ```
63
+
64
+ === "Bash"
65
+
66
+ ```sh
67
+ m365 spo list view set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --viewTitle 'All items' --CustomFormatter "{\"schema\":\"https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json\",\"additionalRowClass\": \"=if([$DueDate] &lt;= @now, 'sp-field-severity--severeWarning', '')\"}"
68
+ ```
@@ -22,7 +22,7 @@ m365 spo list webhook get [options]
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
- `-i, --id [id]`
25
+ `-i, --id <id>`
26
26
  : ID of the webhook.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
@@ -22,14 +22,17 @@ m365 spo list webhook set [options]
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl`.
24
24
 
25
- `-i, --id [id]`
25
+ `-i, --id <id>`
26
26
  : ID of the webhook to update.
27
27
 
28
28
  `-n, --notificationUrl [notificationUrl]`
29
29
  : The new notification url.
30
30
 
31
31
  `-e, --expirationDateTime [expirationDateTime]`
32
- : The new expiration date.
32
+ : The new expiration date. _Note: Expiration Time cannot be more than 6 months in future_
33
+
34
+ `-c, --clientState [clientState]`
35
+ : A client state information that will be passed through notifications.
33
36
 
34
37
  --8<-- "docs/cmd/_global.md"
35
38
 
@@ -51,8 +54,12 @@ Update the expiration date of a webhook with a specific ID attached to a list wi
51
54
  m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --expirationDateTime 2018-10-09T18:15
52
55
  ```
53
56
 
54
- Update the notification url of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
57
+ Update the notification url and clientState of a webhook with a specific ID attached to a list with a specific URL in a specific site to a specific URL and the expiration date to a specific date
55
58
 
56
59
  ```sh
57
- m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02
60
+ m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02 --clientState 'My client state'
58
61
  ```
62
+
63
+ ## Respone
64
+
65
+ The command won't return a response on success.
@@ -14,10 +14,13 @@ m365 spo listitem add [options]
14
14
  : URL of the site where the item should be added
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list where the item should be added. Specify `listId` or `listTitle` but not both
17
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list where the item should be added. Specify `listId` or `listTitle` but not both
20
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-c, --contentType [contentType]`
23
26
  : The name or the ID of the content type to associate with the new item
@@ -64,3 +67,9 @@ Add an item with Title _Demo Hyperlink Field_ and a hyperlink field named _Custo
64
67
  ```sh
65
68
  m365 spo listitem add --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
66
69
  ```
70
+
71
+ Add an item with a specific title to a list retrieved by server-relative URL in a specific site
72
+
73
+ ```sh
74
+ m365 spo listitem add --contentType Item --listUrl /sites/project-x/Documents --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Item"
75
+ ```
@@ -14,10 +14,13 @@ m365 spo listitem attachment list [options]
14
14
  URL of the site from which the item should be retrieved
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list from which to retrieve the item. Specify listId or listTitle but not both
17
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list from which to retrieve the item. Specify listId or listTitle but not both
20
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `--itemId <itemId>`
23
26
  ID of the list item to in question
@@ -37,3 +40,9 @@ Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-
37
40
  ```sh
38
41
  m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
39
42
  ```
43
+
44
+ Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site
45
+
46
+ ```sh
47
+ m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --itemId 147
48
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem get [options]
17
17
  : ID of the item to retrieve.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list from which to retrieve the item. Specify `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list from which to retrieve the item. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `-p, --properties [properties]`
26
29
  : Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested
@@ -50,3 +53,9 @@ Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_
50
53
  ```sh
51
54
  m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
52
55
  ```
56
+
57
+ Get an item with specific properties from a list retrieved by server-relative URL in a specific site
58
+
59
+ ```sh
60
+ m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
61
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem isrecord [options]
17
17
  : The ID of the list item to check if it is a record
18
18
 
19
19
  `-l, --listId [listId]`
20
- : The ID of the list where the item is located. Specify `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : The title of the list where the item is located. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -37,3 +40,10 @@ Check whether the document with id _1_ in list with id _0cd891ef-afce-4e55-b836-
37
40
  ```sh
38
41
  m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
39
42
  ```
43
+
44
+ Check whether a document with a specific id in a list retrieved by server-relative URL in a specific site is a record
45
+
46
+ ```sh
47
+ m365 spo listitem isrecord --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/documents --id 1
48
+ ```
49
+
@@ -16,8 +16,11 @@ m365 spo listitem list [options]
16
16
  `-i, --listId [listId]`
17
17
  : ID of the list to retrieve items from. Specify `listId` or `listTitle` but not both
18
18
 
19
+ `-l, --listId [listId]`
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
+
19
22
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-q, --camlQuery [camlQuery]`
23
26
  : CAML query to use to query the list of items with
@@ -85,3 +88,9 @@ From a list named _Demo List_ get the second batch of 10 items
85
88
  ```sh
86
89
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
87
90
  ```
91
+
92
+ Get all items from a list by server-relative URL
93
+
94
+ ```sh
95
+ m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
96
+ ```
@@ -14,10 +14,13 @@ m365 spo listitem record declare [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `-l, --listId [listId]`
17
- : The ID of the list where the item is located. Specify `listId` or `listTitle` but not both
17
+ : The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : The title of the list where the item is located. Specify `listId` or `listTitle` but not both
20
+ : The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-i, --listItemId <listItemId>`
23
26
  : The ID of the list item to declare as record
@@ -47,8 +50,8 @@ Declare a document with id _1_ as a record with record declaration date _March 1
47
50
  m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 1 --date 2012-03-14
48
51
  ```
49
52
 
50
- Declare a document with id _1_ as a record with record declaration date _September 3, 2013_ in list with id _ea8e1356-5910-abc9-bc05-2408198057fc_ located in site _https://contoso.sharepoint.com/sites/project-x_
53
+ Declare a document with a specific id as a record with a record declaration date a list retrieved by server-relative URL located in a specific site
51
54
 
52
55
  ```sh
53
- m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listId ea8e1356-5910-abc9-bc05-2408198057fc --listItemId 1 --date 2013-09-03
56
+ m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Demo List' --listItemId 1 --date 2013-09-03
54
57
  ```
@@ -17,10 +17,13 @@ m365 spo listitem record undeclare [options]
17
17
  : ID of the list item to be undeclared as a record.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : The ID of the list where the item is located. Specify `listId` or `listTitle` but not both
20
+ : The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : The title of the list where the item is located. Specify `listId` or `listTitle` but not both
23
+ : The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -37,3 +40,9 @@ Undeclare the list item as a record with ID _1_ from list with title _List 1_ lo
37
40
  ```sh
38
41
  m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
39
42
  ```
43
+
44
+ Undeclare a list item with a specific id as a record from a list retrieved by server-relative URL located in a specific site
45
+
46
+ ```sh
47
+ m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Lists 1' --id 1
48
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem remove [options]
17
17
  : The ID of the list item to remove.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : List id of the list to remove. Specify either `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list to remove. Specify either `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `--recycle`
26
29
  : Recycle the list item
@@ -43,3 +46,9 @@ Remove the list item with ID _1_ from list with title _List 1_ located in site _
43
46
  ```sh
44
47
  m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
45
48
  ```
49
+
50
+ Remove the list item with a specific ID from a list retrieved by server-relative URL located in a specific site
51
+
52
+ ```sh
53
+ m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
54
+ ```
@@ -0,0 +1,81 @@
1
+ # spo listitem roleassignment add
2
+
3
+ Adds a role assignment to a listitem.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo listitem roleassignment add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site where the listitem is located
15
+
16
+ `--listId [listId]`
17
+ : ID of the list. Specify either listId, listTitle or listUrl but not multiple.
18
+
19
+ `--listTitle [listTitle]`
20
+ : Title of the list. Specify either listId, listTitle or listUrl but not multiple.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Relative URL of the list. Specify either listId, listTitle or listUrl but not multiple.
24
+
25
+ `--listItemId <listItemId>`
26
+ : Id of the listitem to assign the role to.
27
+
28
+ `--principalId [principalId]`
29
+ : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
30
+
31
+ `--upn [upn]`
32
+ : upn/email of user to assign role to. Specify either upn, groupName or principalId.
33
+
34
+ `--groupName [groupName]`
35
+ : The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
36
+
37
+ `--roleDefinitionId [roleDefinitionId]`
38
+ : ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
39
+
40
+ `--roleDefinitionName [roleDefinitionName]`
41
+ : Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
42
+
43
+ --8<-- "docs/cmd/_global.md"
44
+
45
+ ## Examples
46
+
47
+ Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
48
+
49
+ ```sh
50
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
51
+ ```
52
+
53
+ Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
54
+
55
+ ```sh
56
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "0CD891EF-AFCE-4E55-B836-FCE03286CCCF" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
57
+ ```
58
+
59
+ Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
60
+
61
+ ```sh
62
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl "sites/documents" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
63
+ ```
64
+
65
+ Add role assignment to specified listitem in specified list located in specified site for specified upn and specified role definition id.
66
+
67
+ ```sh
68
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
69
+ ```
70
+
71
+ Add role assignment to specified listitem in specified list located in specified site for specified group and specified role definition id.
72
+
73
+ ```sh
74
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --groupName "someGroup" --roleDefinitionId 1073741829
75
+ ```
76
+
77
+ Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition name.
78
+
79
+ ```sh
80
+ m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionName "Full Control"
81
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem roleinheritance break [options]
17
17
  : ID of the item for which to break role inheritance
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list. Specify listId or listTitle but not both
20
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list. Specify listId or listTitle but not both
23
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `-c, --clearExistingPermissions`
26
29
  : Set to clear existing roles from the list item
@@ -54,10 +57,10 @@ Break inheritance of list item _1_ in list _someList_ located in site _https://c
54
57
  m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --listItemId 1 --clearExistingPermissions
55
58
  ```
56
59
 
57
- Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
60
+ Break inheritance of a specific list item in a list retrieved by server-relative URL in a specific site and clear the existing permissions
58
61
 
59
62
  ```sh
60
- m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --listItemId 1 --clearExistingPermissions
63
+ m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --listItemId 1 --clearExistingPermissions
61
64
  ```
62
65
 
63
66
  Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions without prompting for confirmation
@@ -17,10 +17,13 @@ m365 spo listitem roleinheritance reset [options]
17
17
  : ID of the item for which to reset role inheritance
18
18
 
19
19
  `--listId [listId]`
20
- : ID of the list. Specify listId or listTitle but not both
20
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `--listTitle [listTitle]`
23
- : Title of the list. Specify listId or listTitle but not both
23
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `--confirm`
26
29
  : Do not prompt for confirmation before resetting role inheritance.
@@ -41,8 +44,8 @@ Restore role inheritance of list item with id 8 from list with title _test_ loca
41
44
  m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listTitle test
42
45
  ```
43
46
 
44
- Restore role inheritance of list item with id 8 from list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_ without prompting for confirmation
47
+ Restore role inheritance of a list item with a specific id in a list retrieved by server relative URL located in a specific site without prompting for confirmation
45
48
 
46
49
  ```sh
47
- m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listTitle test --confirm
48
- ```
50
+ m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listUrl /sites/project-x/lists/test --confirm
51
+ ```
@@ -17,10 +17,13 @@ m365 spo listitem set [options]
17
17
  : ID of the list item to update.
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list where the item should be updated. Specify `listId` or `listTitle` but not both
20
+ : ID of the list where the item should be updated. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be updated. Specify `listId` or `listTitle` but not both
23
+ : Title of the list where the item should be updated. Specify either `listTitle`, `listId` or `listUrl`
24
+
25
+ `--listUrl [listUrl]`
26
+ : Server- or site-relative URL of the list where the item should be updated. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
28
  `-c, --contentType [contentType]`
26
29
  : The name or the ID of the content type to associate with the updated item
@@ -62,8 +65,8 @@ Update an item with id _147_ with Title _Demo Multi Person Field_ and a multi-se
62
65
  m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Multi Person Field" --MultiPeopleField "[{'Key':'i:0#.f|membership|markh@conotoso.com'},{'Key':'i:0#.f|membership|adamb@conotoso.com'}]"
63
66
  ```
64
67
 
65
- Update an item with id _147_ with Title _Demo Hyperlink Field_ and a hyperlink field named _CustomHyperlink_ to list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
68
+ Update the field _Title_ and _CustomHyperlink_ of an item with a specific id in a list retrieved by server-relative URL in a specific site
66
69
 
67
70
  ```sh
68
- m365 spo listitem set --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
71
+ m365 spo listitem set --listUrl '/sites/project-x/lists/Demo List' --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --Title "Demo Hyperlink Field" --CustomHyperlink "https://www.bing.com, Bing"
69
72
  ```
@@ -45,7 +45,8 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
45
45
 
46
46
  To add a standard web part to the page, specify one of the following values: _ContentRollup, BingMap, ContentEmbed, DocumentEmbed, Image, ImageGallery, LinkPreview, NewsFeed, NewsReel, PowerBIReportEmbed, QuickChart, SiteActivity, VideoEmbed, YammerEmbed, Events, GroupCalendar, Hero, List, PageTitle, People, QuickLinks, CustomMessageRegion, Divider, MicrosoftForms, Spacer_.
47
47
 
48
- When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
48
+ !!! warning "Escaping JSON in PowerShell"
49
+ When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
49
50
 
50
51
  ## Examples
51
52
 
@@ -67,20 +68,14 @@ Add a custom web part to the modern page
67
68
  m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --webPartId 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1
68
69
  ```
69
70
 
70
- Using PowerShell, add the standard Bing Map web part with the specific properties to a modern page
71
-
72
- ```PowerShell
73
- m365 --% spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties `"{""Title"":""Foo location""}"`
74
- ```
75
-
76
- Using Windows command line, add the standard Bing Map web part with the specific properties to a modern page
71
+ Add the standard Bing Map web part with the specific properties to a modern page
77
72
 
78
73
  ```sh
79
- m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties `"{""Title"":""Foo location""}"`
74
+ m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart BingMap --webPartProperties '{"Title":"Foo location"}'
80
75
  ```
81
76
 
82
77
  Add the standard Image web part with the preconfigured image
83
78
 
84
79
  ```sh
85
- m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '`{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}`'
80
+ m365 spo page clientsidewebpart add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --standardWebPart Image --webPartData '{ "dataVersion": "1.8", "serverProcessedContent": {"htmlStrings":{},"searchablePlainTexts":{"captionText":""},"imageSources":{"imageSource":"/sites/team-a/SiteAssets/work-life-balance.png"},"links":{}}, "properties": {"imageSourceType":2,"altText":"a group of people on a beach","overlayText":"Work life balance","fileName":"48146-OFF12_Justice_01.png","siteId":"27664b85-067d-4be9-a7d7-89b2e804d09f","webId":"a7664b85-067d-4be9-a7d7-89b2e804d09f","listId":"37664b85-067d-4be9-a7d7-89b2e804d09f","uniqueId":"67664b85-067d-4be9-a7d7-89b2e804d09f","imgWidth":650,"imgHeight":433,"fixAspectRatio":false,"isOverlayTextEnabled":true}}'
86
81
  ```
@@ -31,7 +31,8 @@ m365 spo page control set [options]
31
31
 
32
32
  If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
33
33
 
34
- When specifying the JSON string with web part properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _webPartProperties_ option: `{"Foo":"Bar"}`, you should specify the value as \`"{""Foo"":""Bar""}"\`. In addition, when using PowerShell, you should use the `--%` argument.
34
+ !!! warning "Escaping JSON in PowerShell"
35
+ When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
35
36
 
36
37
  ## Examples
37
38
 
@@ -1,11 +1,11 @@
1
- # spo hubsite theme sync
1
+ # spo site hubsite theme sync
2
2
 
3
- Applies any theme updates from the parent hub site.
3
+ Applies any theme updates from the hub site the site is connected to.
4
4
 
5
5
  ## Usage
6
6
 
7
7
  ```sh
8
- m365 spo hubsite theme sync [options]
8
+ m365 spo site hubsite theme sync [options]
9
9
  ```
10
10
 
11
11
  ## Options
@@ -22,10 +22,10 @@ m365 spo hubsite theme sync [options]
22
22
 
23
23
  ## Examples
24
24
 
25
- Applies any theme updates from the parent hub site to the site with URL https://contoso.sharepoint.com/sites/project-x
25
+ Applies any theme updates from the hub site to a specific site
26
26
 
27
27
  ```sh
28
- m365 spo hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
28
+ m365 spo site hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
29
29
  ```
30
30
 
31
31
  ## More information
@@ -45,6 +45,11 @@ m365 spo term add [options]
45
45
  !!! important
46
46
  To use this command you have to have permissions to access the tenant admin site.
47
47
 
48
+ ## Remarks
49
+
50
+ !!! warning "Escaping JSON in PowerShell"
51
+ When using the `--customProperties` and/or `--localCustomProperties` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
52
+
48
53
  ## Examples
49
54
 
50
55
  Add taxonomy term with the specified name to the term group and term set specified by their names
@@ -33,6 +33,11 @@ m365 spo term set add [options]
33
33
  !!! important
34
34
  To use this command you have to have permissions to access the tenant admin site.
35
35
 
36
+ ## Remarks
37
+
38
+ !!! warning "Escaping JSON in PowerShell"
39
+ When using the `--customProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
40
+
36
41
  ## Examples
37
42
 
38
43
  Add taxonomy term set to the term group specified by ID
@@ -56,5 +61,5 @@ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-
56
61
  Add taxonomy term set and set its custom properties
57
62
 
58
63
  ```sh
59
- m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '`{"Property":"Value"}`'
64
+ m365 spo term set add --name PnP-Organizations --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --customProperties '{"Property":"Value"}'
60
65
  ```
@@ -0,0 +1,44 @@
1
+ # spo web roleinheritance break
2
+
3
+ Break role inheritance of subsite
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo web roleinheritance break [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : URL of the site.
15
+
16
+ `-c, --clearExistingPermissions`
17
+ : Clears all existing permissions from the web.
18
+
19
+ `--confirm`
20
+ : Don't prompt for confirmation.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ By default, when breaking permissions inheritance, the web will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
27
+
28
+ ## Examples
29
+
30
+ Break role inheritance of a web and keep the existing permissions
31
+
32
+ ```sh
33
+ m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x
34
+ ```
35
+
36
+ Break role inheritance of a web and clear the existing permissions
37
+
38
+ ```sh
39
+ m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --clearExistingPermissions
40
+ ```
41
+
42
+ ## Response
43
+
44
+ The command won't return a response on success.