@pnp/cli-microsoft365 5.9.0-beta.86c5624 → 5.9.0-beta.8773bb6

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 (111) 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/card/card-list.js +68 -0
  10. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +6 -12
  11. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  12. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  13. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  14. package/dist/m365/pp/commands.js +5 -0
  15. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  16. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  26. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  27. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  28. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  29. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  30. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  31. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  32. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  33. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +129 -0
  34. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  35. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  36. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  37. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  38. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  39. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  40. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  41. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  42. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  43. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  44. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  45. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  46. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  47. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  48. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  49. package/dist/m365/spo/commands.js +4 -0
  50. package/dist/m365/teams/commands/channel/channel-add.js +9 -9
  51. package/dist/m365/todo/commands/list/list-get.js +89 -0
  52. package/dist/m365/todo/commands/task/task-add.js +55 -3
  53. package/dist/m365/todo/commands/task/task-set.js +53 -1
  54. package/dist/m365/todo/commands.js +1 -0
  55. package/docs/docs/_clisettings.md +19 -0
  56. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  57. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  58. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  59. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  60. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  61. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  62. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  63. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  64. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  65. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  66. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  67. package/docs/docs/cmd/pp/card/card-list.md +33 -0
  68. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  69. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  70. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  71. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  72. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  73. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  74. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  75. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  76. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  77. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  78. package/docs/docs/cmd/spo/file/file-roleinheritance-break.md +54 -0
  79. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  80. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  81. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  82. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  83. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  84. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  85. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  86. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  87. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  88. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  89. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  90. package/docs/docs/cmd/spo/list/list-webhook-set.md +14 -12
  91. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  92. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  93. package/docs/docs/cmd/teams/channel/channel-add.md +4 -4
  94. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  95. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  96. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  97. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  98. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  99. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  100. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  101. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  102. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  103. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  104. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  105. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  106. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  107. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  108. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  109. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  110. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  111. package/package.json +12 -4
@@ -11,26 +11,35 @@ m365 spo list roleinheritance reset [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list. Specify either id or title but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list. Specify either id or title but not both
20
+ : Title of the list. 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
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
29
+ Restores role inheritance of a specific list by id in a specific site
27
30
 
28
31
  ```sh
29
32
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
30
33
  ```
31
34
 
32
- Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ Restores role inheritance of a specific list by title in a specific site
33
36
 
34
37
  ```sh
35
38
  m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
36
39
  ```
40
+
41
+ Restores role inheritance of a specific list by url in a specific site
42
+
43
+ ```sh
44
+ m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/events'
45
+ ```
@@ -11,46 +11,45 @@ m365 spo list webhook add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to add the webhook to is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list to which the webhook which should be added. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to which the webhook which should be added. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. 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
  `-n, --notificationUrl <notificationUrl>`
23
- : The notification url
26
+ : The notification URL.
24
27
 
25
28
  `-e, --expirationDateTime [expirationDateTime]`
26
- : The expiration date. Will be set to max (6 months from today) if not provided
29
+ : The expiration date. Will be set to max (6 months from today) if not provided.
27
30
 
28
31
  `-c, --clientState [clientState]`
29
- : A client state information that will be passed through notifications
32
+ : A client state information that will be passed through notifications.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
33
36
  ## Examples
34
37
 
35
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
36
- _https://contoso-funcions.azurewebsites.net/webhook_ and the default expiration
37
- date
38
+ Add a web hook to the list retrieved by Title located in a specific site with a specific notification url and the default expiration date
38
39
 
39
40
  ```sh
40
41
  m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook
41
42
  ```
42
43
 
43
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
44
- _https://contoso-funcions.azurewebsites.net/webhook_ and an expiration date of _January 21st, 2019_
44
+ Add a web hook to the list retrieved by URL located in a specific site with a specific notification url and a specific expiration date
45
45
 
46
46
  ```sh
47
- m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime 2019-01-21
47
+ m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime 2019-01-21
48
48
  ```
49
49
 
50
- Add a web hook to the list Documents located in site _https://contoso.sharepoint.com/sites/ninja_ with the notification url
51
- _https://contoso-funcions.azurewebsites.net/webhook_, a very specific expiration date of _6:15 PM on March 2nd, 2019_ and
52
- a client state
50
+ Add a web hook to the list retrieved by ID located in a specific site with a specific notification url, a specific expiration date and a client state
51
+
53
52
 
54
53
  ```sh
55
- m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime '2019-03-02T18:15' --clientState "Hello State!"
54
+ m365 spo list webhook add --webUrl https://contoso.sharepoint.com/sites/ninja --listId '3d6aefa0-f438-4789-b0cd-6e865f5d65b5' --notificationUrl https://contoso-funcions.azurewebsites.net/webhook --expirationDateTime '2019-03-02T18:15' --clientState "Hello State!"
56
55
  ```
@@ -11,16 +11,19 @@ m365 spo list webhook get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve the webhook info for is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list from which to retrieve the webhook. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list from which to retrieve the webhook. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
21
21
 
22
- `-i, --id [id]`
23
- : ID of the webhook to retrieve
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
24
+
25
+ `-i, --id <id>`
26
+ : ID of the webhook.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -30,14 +33,20 @@ If the specified `id` doesn't refer to an existing webhook, you will get a `404
30
33
 
31
34
  ## Examples
32
35
 
33
- Return information about a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e85_ which belongs to a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Return information about a specific webhook which belongs to a list retrieved by ID in a specific site
34
37
 
35
38
  ```sh
36
39
  m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e85
37
40
  ```
38
41
 
39
- Return information about a webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e85_ which belongs to a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Return information about a specific webhook which belongs to a list retrieved by Title in a specific site
40
43
 
41
44
  ```sh
42
45
  m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e85
43
46
  ```
47
+
48
+ Return information about a specific webhook which belongs to a list retrieved by URL in a specific site
49
+
50
+ ```sh
51
+ m365 spo list webhook get --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e85
52
+ ```
@@ -11,32 +11,41 @@ m365 spo list webhook list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to retrieve webhooks for is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-i, --listId [listId]`
17
- : ID of the list to retrieve all webhooks for. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
20
- : Title of the list to retrieve all webhooks for. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
- : (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id` or `title` but not both
26
+ : (deprecated. Use `listId` instead) ID of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
24
27
 
25
28
  `--title [title]`
26
- : (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id` or `title` but not both
29
+ : (deprecated. Use `listTitle` instead) Title of the list to retrieve all webhooks for. Specify either `id`, `title`, `listTitle`, `listId` or `listUrl`.
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
30
33
  ## Examples
31
34
 
32
- List all webhooks for a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
35
+ List all webhooks for a list with a specific ID in a specific site
33
36
 
34
37
  ```sh
35
38
  m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
36
39
  ```
37
40
 
38
- List all webhooks for a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
41
+ List all webhooks for a list with a specific title in a specific site
39
42
 
40
43
  ```sh
41
44
  m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
42
45
  ```
46
+
47
+ List all webhooks for a list with a specific URL in a specific site
48
+
49
+ ```sh
50
+ m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Documents'
51
+ ```
@@ -11,19 +11,22 @@ m365 spo list webhook remove [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the list to remove the webhook from is located
14
+ : URL of the site where the list is located.
15
15
 
16
16
  `-l, --listId [listId]`
17
- : ID of the list from which the webhook should be removed. 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 from which the webhook should be removed. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list. 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
  `-i, --id <id>`
23
- : ID of the webhook to remove
26
+ : ID of the webhook.
24
27
 
25
28
  `--confirm`
26
- : Don't prompt for confirming removing the webhook
29
+ : Don't prompt for confirmation.
27
30
 
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
@@ -33,20 +36,19 @@ If the specified id doesn't refer to an existing webhook, you will get a `404 -
33
36
 
34
37
  ## Examples
35
38
 
36
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/ninja_
39
+ Remove webhook with a specific ID from a list retrieved by ID in a specific site
37
40
 
38
41
  ```sh
39
42
  m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81
40
43
  ```
41
44
 
42
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_
43
-
45
+ Remove webhook with a specific ID from a list retrieved by Title in a specific site
44
46
  ```sh
45
47
  m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81
46
48
  ```
47
49
 
48
- Remove webhook with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/ninja_ without being asked for confirmation
50
+ Remove webhook with a specific ID from a list retrieved by URL in a specific site without being asked for confirmation
49
51
 
50
52
  ```sh
51
- m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listTitle Documents --id cc27a922-8224-4296-90a5-ebbc54da2e81 --confirm
53
+ m365 spo list webhook remove --webUrl https://contoso.sharepoint.com/sites/ninja --listUrl '/sites/ninja/Documents' --id cc27a922-8224-4296-90a5-ebbc54da2e81 --confirm
52
54
  ```
@@ -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
  ```
@@ -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
+ ```
@@ -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.
@@ -23,10 +23,10 @@ m365 teams channel add [options]
23
23
  : The description of the channel to add
24
24
 
25
25
  `--type [type]`
26
- : Type of channel to create: `standard,private`. Default `standard`.
26
+ : Type of channel to create: `standard`, `private`, `shared`. Default `standard`.
27
27
 
28
28
  `--owner [owner]`
29
- : User with this ID or UPN will be added as owner of the private channel. This option is required when type is `private`.
29
+ : User with this ID or UPN will be added as owner of the channel. This option is required when type is `private` or `shared`.
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
@@ -54,8 +54,8 @@ Add private channel to the specified Microsoft Teams team with owner UPN
54
54
  m365 teams channel add --teamName "Team Name" --name climicrosoft365 --type private --owner john.doe@contoso.com
55
55
  ```
56
56
 
57
- Add private channel to the specified Microsoft Teams team with owner ID
57
+ Add shared channel to the specified Microsoft Teams team with owner ID
58
58
 
59
59
  ```sh
60
- m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type private --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
60
+ m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type shared --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
61
61
  ```
@@ -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
+ ```
@@ -19,3 +19,33 @@ Get the count of users that are enabled and those that have activated the Office
19
19
  ```sh
20
20
  m365 tenant report office365activationsusercounts
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
+ "Assigned": 24,
33
+ "Activated": 5,
34
+ "Shared Computer Activation": 0
35
+ }
36
+ ]
37
+ ```
38
+
39
+ === "Text"
40
+
41
+ ```text
42
+ Report Refresh Date,Product Type,Assigned,Activated,Shared Computer Activation
43
+ 2022-10-25,MICROSOFT 365 APPS FOR ENTERPRISE,24,5,0
44
+ ```
45
+
46
+ === "CSV"
47
+
48
+ ```csv
49
+ Report Refresh Date,Product Type,Assigned,Activated,Shared Computer Activation
50
+ 2022-10-25,MICROSOFT 365 APPS FOR ENTERPRISE,24,5,0
51
+ ```