@pnp/cli-microsoft365 5.9.0-beta.174dde9 → 5.9.0-beta.1f313f7

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 (132) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/Command.js +16 -2
  3. package/dist/m365/aad/commands/app/app-add.js +37 -13
  4. package/dist/m365/commands/status.js +6 -1
  5. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  6. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  7. package/dist/m365/pp/commands/Environment.js +3 -0
  8. package/dist/m365/pp/commands/card/card-get.js +110 -0
  9. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  10. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  11. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  12. package/dist/m365/pp/commands.js +4 -0
  13. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  14. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  15. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  16. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  26. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  27. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  28. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  29. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  30. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  31. package/dist/m365/spo/commands/field/field-add.js +26 -1
  32. package/dist/m365/spo/commands/field/field-set.js +23 -13
  33. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  34. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  35. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  36. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  37. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  38. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  39. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  40. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  41. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  42. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  43. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  44. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  45. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  46. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  47. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  48. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  49. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  50. package/dist/m365/spo/commands/listitem/listitem-list.js +27 -11
  51. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  52. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  53. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  54. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  55. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  56. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +14 -6
  57. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  58. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  59. package/dist/m365/spo/commands.js +3 -0
  60. package/dist/m365/todo/commands/list/list-get.js +89 -0
  61. package/dist/m365/todo/commands/task/task-add.js +55 -3
  62. package/dist/m365/todo/commands/task/task-get.js +108 -0
  63. package/dist/m365/todo/commands/task/task-set.js +53 -1
  64. package/dist/m365/todo/commands.js +2 -0
  65. package/docs/docs/_clisettings.md +19 -0
  66. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  67. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  68. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  69. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  70. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  71. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  72. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  73. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  74. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  75. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  76. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  77. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  78. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  79. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  80. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  81. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  82. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  83. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  84. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  85. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  86. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  87. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  88. package/docs/docs/cmd/spo/field/field-set.md +11 -2
  89. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  90. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  91. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  92. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  93. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  94. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  95. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  96. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  97. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  98. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  99. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  100. package/docs/docs/cmd/spo/list/list-webhook-set.md +14 -12
  101. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  102. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  103. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  104. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  105. package/docs/docs/cmd/spo/listitem/listitem-list.md +12 -3
  106. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  107. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  108. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  109. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  110. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  111. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +11 -2
  112. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  113. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  114. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  115. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  116. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  117. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  118. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  119. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  120. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  121. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  122. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  123. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  124. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  125. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  126. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  127. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  128. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  129. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  130. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  131. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  132. package/package.json +12 -4
@@ -11,22 +11,25 @@ m365 spo list webhook set [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list which contains the webhook is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list which contains the webhook which should be updated. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listId`, `listTitle` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list which contains the webhook which should be updated. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `listId`, `listTitle` or `listUrl`.
21
21
 
22
- `-i, --id [id]`
23
- : ID of the webhook to update
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl`.
24
+
25
+ `-i, --id <id>`
26
+ : ID of the webhook to update.
24
27
 
25
28
  `-n, --notificationUrl [notificationUrl]`
26
- : The new notification url
29
+ : The new notification url.
27
30
 
28
31
  `-e, --expirationDateTime [expirationDateTime]`
29
- : The new expiration date
32
+ : The new expiration date. _Note: Expiration Time cannot be more than 6 months in future_
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -36,21 +39,20 @@ If the specified `id` doesn't refer to an existing webhook, you will get a `404
36
39
 
37
40
  ## Examples
38
41
 
39
- Update the notification url of a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ which belongs to a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/ninja_ to _https://contoso-functions.azurewebsites.net/webhook_
42
+ Update the notification url of a webhook with a specific ID attached to a list with a specific ID in a specific site to a specific URL
40
43
 
41
44
  ```sh
42
45
  m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook
43
46
  ```
44
47
 
45
- Update the expiration date of a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ which belongs to a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_ to _October 9th, 2018 at 6:15 PM_
48
+ Update the expiration date of a webhook with a specific ID attached to a list with a specific title in a specific site to a specfic date
46
49
 
47
50
  ```sh
48
51
  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
49
52
  ```
50
53
 
51
- From the webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ which belongs to a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_ update the notification url to _https://contoso-functions.azurewebsites.net/webhook_
52
- and the expiration date to _March 2nd, 2019_
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
53
55
 
54
56
  ```sh
55
- m365 spo list webhook set --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --notificationUrl https://contoso-functions.azurewebsites.net/webhook --expirationDateTime 2019-03-02
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
56
58
  ```
@@ -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
+
@@ -19,11 +19,14 @@ m365 spo listitem list [options]
19
19
  `--id [id]`
20
20
  : (deprecated. Use `listId` instead) ID of the list to retrieve items from. Specify `id` or `title` but not both
21
21
 
22
+ `-l, --listId [listId]`
23
+ : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
+
22
25
  `-t, --listTitle [listTitle]`
23
- : Title of the list to retrieve items from. Specify `listId` or `listTitle` but not both
26
+ : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
24
27
 
25
- `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve items from. Specify `id` or `title` but not both
28
+ `--listUrl [listUrl]`
29
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
27
30
 
28
31
  `-q, --camlQuery [camlQuery]`
29
32
  : CAML query to use to query the list of items with
@@ -91,3 +94,9 @@ From a list named _Demo List_ get the second batch of 10 items
91
94
  ```sh
92
95
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
93
96
  ```
97
+
98
+ Get all items from a list by server-relative URL
99
+
100
+ ```sh
101
+ m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
102
+ ```
@@ -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, --id <id>`
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" --id 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 --id 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' --id 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' --id 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
@@ -51,8 +54,8 @@ Break inheritance of list item _1_ in list _someList_ located in site _https://c
51
54
  m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --listItemId 1 --clearExistingPermissions
52
55
  ```
53
56
 
54
- 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
57
+ Break inheritance of a specific list item in a list retrieved by server-relative URL in a specific site and clear the existing permissions
55
58
 
56
59
  ```sh
57
- m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --listItemId 1 --clearExistingPermissions
60
+ m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --listItemId 1 --clearExistingPermissions
58
61
  ```
@@ -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
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -37,3 +40,9 @@ Restore role inheritance of list item with id 8 from list with title _test_ loca
37
40
  ```sh
38
41
  m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listTitle test
39
42
  ```
43
+
44
+ Restore role inheritance of a list item with a specific id in a list retrieved by server relative URL located in a specific site
45
+
46
+ ```sh
47
+ m365 spo listitem roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listItemId 8 --listUrl /sites/project-x/lists/test
48
+ ```
@@ -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
  ```
@@ -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.
@@ -32,3 +32,23 @@ Get Microsoft 365 tenant ID of the the tenant to which you are currently logged
32
32
  ```sh
33
33
  m365 tenant id get
34
34
  ```
35
+
36
+ ## Response
37
+
38
+ === "JSON"
39
+
40
+ ```json
41
+ "e65b162c-6f87-4eb1-a24e-1b37d3504663"
42
+ ```
43
+
44
+ === "Text"
45
+
46
+ ```text
47
+ e65b162c-6f87-4eb1-a24e-1b37d3504663
48
+ ```
49
+
50
+ === "CSV"
51
+
52
+ ```csv
53
+ e65b162c-6f87-4eb1-a24e-1b37d3504663
54
+ ```
@@ -37,3 +37,38 @@ Gets the count of daily active users in the reporting period by product for the
37
37
  ```sh
38
38
  m365 tenant report activeusercounts --period D7 --output json > "activeusercounts.json"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "Report Refresh Date": "2022-10-25",
49
+ "Office 365": "1",
50
+ "Exchange": "5",
51
+ "OneDrive": "4",
52
+ "SharePoint": "3",
53
+ "Skype For Business": "2",
54
+ "Yammer": "3",
55
+ "Teams": "1",
56
+ "Report Date": "2022-10-19",
57
+ "Report Period": "7"
58
+ }
59
+ ]
60
+ ```
61
+
62
+ === "Text"
63
+
64
+ ```text
65
+ Report Refresh Date,Office 365,Exchange,OneDrive,SharePoint,Skype For Business,Yammer,Teams,Report Date,Report Period
66
+ 2022-10-25,1,5,4,3,2,3,1,2022-10-19,7
67
+ ```
68
+
69
+ === "CSV"
70
+
71
+ ```csv
72
+ Report Refresh Date,Office 365,Exchange,OneDrive,SharePoint,Skype For Business,Yammer,Teams,Report Date,Report Period
73
+ 2022-10-25,1,5,4,3,2,3,1,2022-10-19,7
74
+ ```
@@ -50,3 +50,52 @@ Gets details about Microsoft 365 active users for the last week and exports the
50
50
  ```sh
51
51
  m365 tenant report activeuserdetail --period D7 --output json > "activeuserdetail.json"
52
52
  ```
53
+
54
+ ## Response
55
+
56
+ === "JSON"
57
+
58
+ ```json
59
+ [
60
+ {
61
+ "Report Refresh Date": "2022-10-23",
62
+ "User Principal Name": "0439A166C614C2E8C7B4075DC4752054",
63
+ "Display Name": "2236A6E43D08F619FE695DF3B163A32F",
64
+ "Is Deleted": "False",
65
+ "Deleted Date": "",
66
+ "Has Exchange License": "True",
67
+ "Has OneDrive License": "True",
68
+ "Has SharePoint License": "True",
69
+ "Has Skype For Business License": "True",
70
+ "Has Yammer License": "True",
71
+ "Has Teams License": "True",
72
+ "Exchange Last Activity Date": "2020-03-27",
73
+ "OneDrive Last Activity Date": "2020-03-27",
74
+ "SharePoint Last Activity Date": "2020-04-30",
75
+ "Skype For Business Last Activity Date": "2020-05-10",
76
+ "Yammer Last Activity Date": "2020-05-10",
77
+ "Teams Last Activity Date": "2020-05-10",
78
+ "Exchange License Assign Date": "2020-02-26",
79
+ "OneDrive License Assign Date": "2020-02-26",
80
+ "SharePoint License Assign Date": "2020-02-26",
81
+ "Skype For Business License Assign Date": "2020-02-26",
82
+ "Yammer License Assign Date": "2020-02-26",
83
+ "Teams License Assign Date": "2020-02-26",
84
+ "Assigned Products": "MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)"
85
+ }
86
+ ]
87
+ ```
88
+
89
+ === "Text"
90
+
91
+ ```text
92
+ Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Has Exchange License,Has OneDrive License,Has SharePoint License,Has Skype For Business License,Has Yammer License,Has Teams License,Exchange Last Activity Date,OneDrive Last Activity Date,SharePoint Last Activity Date,Skype For Business Last Activity Date,Yammer Last Activity Date,Teams Last Activity Date,Exchange License Assign Date,OneDrive License Assign Date,SharePoint License Assign Date,Skype For Business License Assign Date,Yammer License Assign Date,Teams License Assign Date,Assigned Products
93
+ 2022-10-23,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,False,,True,True,True,True,True,True,2020-09-12,2022-09-12,2021-10-30,2020-10-30,2019-04-21,2017-09-20,2021-01-10,2021-01-10,2021-01-10,2021-01-10,2021-01-10,2021-01-10,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)
94
+ ```
95
+
96
+ === "CSV"
97
+
98
+ ```csv
99
+ Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Has Exchange License,Has OneDrive License,Has SharePoint License,Has Skype For Business License,Has Yammer License,Has Teams License,Exchange Last Activity Date,OneDrive Last Activity Date,SharePoint Last Activity Date,Skype For Business Last Activity Date,Yammer Last Activity Date,Teams Last Activity Date,Exchange License Assign Date,OneDrive License Assign Date,SharePoint License Assign Date,Skype For Business License Assign Date,Yammer License Assign Date,Teams License Assign Date,Assigned Products
100
+ 2022-10-23,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,False,,True,True,True,True,True,True,,2022-09-12,2020-09-12,2022-09-12,2021-10-30,2020-10-30,2019-04-21,2017-09-20,2021-01-10,2021-01-10,2021-01-10,2021-01-10,2021-01-10,2021-01-10,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)
101
+ ```
@@ -19,3 +19,35 @@ Get the count of Microsoft 365 activations on desktops and devices
19
19
  ```sh
20
20
  m365 tenant report office365activationcounts
21
21
  ```
22
+
23
+ ## Response
24
+
25
+ === "JSON"
26
+
27
+ ```json
28
+ [
29
+ {
30
+ "Report Refresh Date": "2022-10-25",
31
+ "Product Type": "MICROSOFT 365 APPS FOR ENTERPRISE",
32
+ "Windows": 5,
33
+ "Mac": 0,
34
+ "Android": 0,
35
+ "iOS": 0,
36
+ "Windows 10 Mobile": 0
37
+ }
38
+ ]
39
+ ```
40
+
41
+ === "Text"
42
+
43
+ ```text
44
+ Report Refresh Date,Product Type,Windows,Mac,Android,iOS,Windows 10 Mobile
45
+ 2022-10-25,MICROSOFT 365 APPS FOR ENTERPRISE,5,0,0,0,0
46
+ ```
47
+
48
+ === "CSV"
49
+
50
+ ```csv
51
+ Report Refresh Date,Product Type,Windows,Mac,Android,iOS,Windows 10 Mobile
52
+ 2022-10-25,MICROSOFT 365 APPS FOR ENTERPRISE,5,0,0,0,0
53
+ ```