@pnp/cli-microsoft365 5.0.0-beta.aff293c → 5.0.0-beta.c4100fe

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 (159) hide show
  1. package/.devcontainer/Dockerfile +2 -2
  2. package/.devcontainer/devcontainer.json +13 -2
  3. package/.eslintrc.js +3 -0
  4. package/.mocharc.json +9 -0
  5. package/README.md +3 -3
  6. package/dist/Command.js +1 -1
  7. package/dist/Utils.js +7 -0
  8. package/dist/api.d.ts +11 -0
  9. package/dist/api.js +17 -0
  10. package/dist/appInsights.js +5 -2
  11. package/dist/cli/Cli.js +42 -7
  12. package/dist/m365/aad/commands/app/app-add.js +101 -12
  13. package/dist/m365/aad/commands/app/app-delete.js +123 -0
  14. package/dist/m365/aad/commands/app/app-get.js +142 -0
  15. package/dist/m365/aad/commands/app/app-set.js +98 -3
  16. package/dist/m365/aad/commands/group/group-list.js +54 -0
  17. package/dist/m365/aad/commands/o365group/{GroupUser.js → GroupExtended.js} +1 -1
  18. package/dist/m365/aad/commands/o365group/o365group-add.js +56 -50
  19. package/dist/m365/aad/commands/o365group/o365group-conversation-list.js +41 -0
  20. package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
  21. package/dist/m365/aad/commands/oauth2grant/oauth2grant-add.js +5 -8
  22. package/dist/m365/aad/commands/oauth2grant/oauth2grant-list.js +7 -7
  23. package/dist/m365/aad/commands/oauth2grant/oauth2grant-remove.js +36 -12
  24. package/dist/m365/aad/commands/oauth2grant/oauth2grant-set.js +3 -3
  25. package/dist/m365/aad/commands/sp/sp-add.js +107 -0
  26. package/dist/m365/aad/commands/sp/sp-get.js +44 -21
  27. package/dist/m365/aad/commands/user/user-get.js +33 -6
  28. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  29. package/dist/m365/aad/commands/user/user-list.js +7 -4
  30. package/dist/m365/aad/commands/user/user-password-validate.js +42 -0
  31. package/dist/m365/aad/commands.js +7 -0
  32. package/dist/m365/app/commands/permission/permission-list.js +266 -0
  33. package/dist/m365/app/commands.js +7 -0
  34. package/dist/m365/base/AppCommand.js +76 -0
  35. package/dist/m365/{aad/commands/o365group/Group.js → base/M365RcJson.js} +1 -1
  36. package/dist/m365/cli/commands/cli-doctor.js +2 -0
  37. package/dist/m365/cli/commands/config/config-set.js +4 -1
  38. package/dist/m365/file/commands/file-add.js +32 -13
  39. package/dist/m365/file/commands/file-list.js +181 -0
  40. package/dist/m365/file/commands.js +2 -1
  41. package/dist/m365/flow/commands/flow-get.js +2 -2
  42. package/dist/m365/outlook/commands/room/room-list.js +43 -0
  43. package/dist/m365/outlook/commands/roomlist/roomlist-list.js +25 -0
  44. package/dist/m365/outlook/commands.js +2 -0
  45. package/dist/m365/pa/cds-project-mutator.js +1 -1
  46. package/dist/m365/pa/commands/app/app-list.js +28 -1
  47. package/dist/m365/planner/AppliedCategories.js +3 -0
  48. package/dist/m365/planner/commands/task/task-add.js +288 -0
  49. package/dist/m365/planner/commands/task/task-details-get.js +39 -0
  50. package/dist/m365/planner/commands/task/task-get.js +37 -0
  51. package/dist/m365/planner/commands/task/task-list.js +37 -7
  52. package/dist/m365/planner/commands/task/task-set.js +357 -0
  53. package/dist/m365/planner/commands.js +5 -1
  54. package/dist/m365/search/commands/externalconnection/externalconnection-add.js +99 -0
  55. package/dist/m365/search/commands.js +7 -0
  56. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006005_CFG_PS_metadata.js +63 -0
  57. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +60 -0
  58. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
  59. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.13.1.js +53 -0
  60. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0.js +59 -0
  61. package/dist/m365/spfx/commands/project/project-upgrade.js +3 -1
  62. package/dist/m365/spfx/commands/spfx-doctor.js +197 -64
  63. package/dist/m365/spo/commands/contenttype/contenttype-list.js +52 -0
  64. package/dist/m365/spo/commands/group/group-user-add.js +74 -16
  65. package/dist/m365/spo/commands/group/group-user-remove.js +100 -0
  66. package/dist/m365/spo/commands/list/list-get.js +6 -2
  67. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +90 -0
  68. package/dist/m365/spo/commands/page/Page.js +3 -1
  69. package/dist/m365/spo/commands/page/page-add.js +7 -10
  70. package/dist/m365/spo/commands/page/page-set.js +7 -10
  71. package/dist/m365/spo/commands/site/site-ensure.js +1 -1
  72. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  73. package/dist/m365/spo/commands/site/site-remove.js +98 -30
  74. package/dist/m365/spo/commands/web/web-installedlanguage-list.js +48 -0
  75. package/dist/m365/spo/commands.js +6 -1
  76. package/dist/m365/teams/commands/app/app-install.js +75 -21
  77. package/dist/m365/teams/commands/app/app-list.js +9 -6
  78. package/dist/m365/teams/commands/app/app-update.js +55 -12
  79. package/dist/m365/teams/commands/channel/channel-get.js +29 -7
  80. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  81. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  82. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  83. package/dist/m365/teams/commands/chat/chat-message-send.js +225 -0
  84. package/dist/m365/teams/commands/message/message-get.js +1 -1
  85. package/dist/m365/teams/commands/report/report-directroutingcalls.js +1 -1
  86. package/dist/m365/teams/commands/report/report-pstncalls.js +1 -1
  87. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  88. package/dist/m365/teams/commands.js +4 -0
  89. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
  90. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
  91. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +39 -0
  92. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +38 -0
  93. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js +51 -0
  94. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +38 -0
  95. package/dist/m365/tenant/commands.js +6 -0
  96. package/dist/request.js +9 -4
  97. package/dist/settingsNames.js +6 -1
  98. package/docs/docs/cmd/_global.md +2 -2
  99. package/docs/docs/cmd/aad/app/app-add.md +11 -0
  100. package/docs/docs/cmd/aad/app/app-delete.md +51 -0
  101. package/docs/docs/cmd/aad/app/app-get.md +59 -0
  102. package/docs/docs/cmd/aad/app/app-set.md +21 -0
  103. package/docs/docs/cmd/aad/group/group-list.md +30 -0
  104. package/docs/docs/cmd/aad/o365group/o365group-add.md +1 -0
  105. package/docs/docs/cmd/aad/o365group/o365group-conversation-list.md +24 -0
  106. package/docs/docs/cmd/aad/oauth2grant/oauth2grant-list.md +4 -3
  107. package/docs/docs/cmd/aad/oauth2grant/oauth2grant-remove.md +9 -0
  108. package/docs/docs/cmd/aad/oauth2grant/oauth2grant-set.md +3 -2
  109. package/docs/docs/cmd/aad/sp/sp-add.md +53 -0
  110. package/docs/docs/cmd/aad/sp/sp-get.md +2 -1
  111. package/docs/docs/cmd/aad/user/user-get.md +13 -4
  112. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  113. package/docs/docs/cmd/aad/user/user-list.md +9 -0
  114. package/docs/docs/cmd/aad/user/user-password-validate.md +29 -0
  115. package/docs/docs/cmd/app/permission/permission-list.md +36 -0
  116. package/docs/docs/cmd/file/file-add.md +11 -0
  117. package/docs/docs/cmd/file/file-list.md +46 -0
  118. package/docs/docs/cmd/outlook/room/room-list.md +30 -0
  119. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +21 -0
  120. package/docs/docs/cmd/pa/app/app-list.md +17 -1
  121. package/docs/docs/cmd/planner/task/task-add.md +78 -0
  122. package/docs/docs/cmd/planner/task/task-details-get.md +24 -0
  123. package/docs/docs/cmd/planner/task/task-get.md +29 -0
  124. package/docs/docs/cmd/planner/task/task-list.md +5 -0
  125. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  126. package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +43 -0
  127. package/docs/docs/cmd/spfx/project/project-externalize.md +1 -1
  128. package/docs/docs/cmd/spfx/project/project-rename.md +1 -1
  129. package/docs/docs/cmd/spfx/project/project-upgrade.md +8 -8
  130. package/docs/docs/cmd/spfx/spfx-doctor.md +1 -1
  131. package/docs/docs/cmd/spo/contenttype/contenttype-list.md +33 -0
  132. package/docs/docs/cmd/spo/group/group-user-add.md +28 -6
  133. package/docs/docs/cmd/spo/group/group-user-remove.md +39 -0
  134. package/docs/docs/cmd/spo/list/list-get.md +9 -0
  135. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +39 -0
  136. package/docs/docs/cmd/spo/page/page-add.md +2 -2
  137. package/docs/docs/cmd/spo/page/page-set.md +3 -3
  138. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  139. package/docs/docs/cmd/spo/site/site-remove.md +3 -1
  140. package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +24 -0
  141. package/docs/docs/cmd/teams/app/app-install.md +22 -4
  142. package/docs/docs/cmd/teams/app/app-update.md +12 -3
  143. package/docs/docs/cmd/teams/channel/channel-get.md +11 -2
  144. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  145. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  146. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  147. package/docs/docs/cmd/teams/chat/chat-message-send.md +55 -0
  148. package/docs/docs/cmd/teams/message/message-get.md +0 -3
  149. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +0 -3
  150. package/docs/docs/cmd/teams/report/report-pstncalls.md +4 -3
  151. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
  152. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
  153. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +24 -0
  154. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +34 -0
  155. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +28 -0
  156. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +34 -0
  157. package/npm-shrinkwrap.json +1740 -2288
  158. package/package.json +46 -33
  159. package/dist/m365/base/AadCommand.js +0 -10
@@ -0,0 +1,36 @@
1
+ # app permission list
2
+
3
+ Lists API permissions for the current AAD app
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 app permission list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ Use this command to quickly look up API permissions for the Azure AD application registration registered in the .m365rc.json file in your current project (folder).
21
+
22
+ If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
23
+
24
+ ## Examples
25
+
26
+ Retrieve API permissions for your current Azure AD app
27
+
28
+ ```sh
29
+ m365 app permission list
30
+ ```
31
+
32
+ Retrieve API permissions for the Azure AD app with client ID _e23d235c-fcdf-45d1-ac5f-24ab2ee0695d_ specified in the _.m365rc.json_ file
33
+
34
+ ```sh
35
+ m365 app permission list --appId e23d235c-fcdf-45d1-ac5f-24ab2ee0695d
36
+ ```
@@ -16,12 +16,17 @@ m365 file add [options]
16
16
  `-p, --filePath <filePath>`
17
17
  : Local path to the file to upload
18
18
 
19
+ `--siteUrl [siteUrl]`
20
+ : URL of the site to which upload the file. Specify to suppress lookup.
21
+
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Remarks
22
25
 
23
26
  The `folderUrl` must be an absolute URL to the document library where the file should be uploaded. The document library can be located in any site collection in your tenant, including OneDrive for Business. The `folderUrl` can also point to a (sub)folder in the document library.
24
27
 
28
+ By default, the `file add` command will automatically lookup the ID of the site where you want to upload the file based on the specified `folderUrl`. It will do this, by breaking the URL into chunks and incrementally calling Microsoft Graph to retrieve site information. This is necessary, because there is no other way looking at the URL to distinguish where the site URL ends and the document library URL starts. If you want to speed up uploading files, or you use resource-specific consent and your Azure AD app only has access to the specific site, you can use the `siteUrl` option to specify the URL of the site yourself.
29
+
25
30
  ## Examples
26
31
 
27
32
  Uploads file from the current folder to the root folder of a document library in the root site collection
@@ -47,3 +52,9 @@ Uploads file from the current folder to a document library in a non-root site co
47
52
  ```sh
48
53
  m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents"
49
54
  ```
55
+
56
+ Uploads file from the current folder to a document library in the specified site
57
+
58
+ ```sh
59
+ m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents" --siteUrl "https://contoso.sharepoint.com/sites/Contoso"
60
+ ```
@@ -0,0 +1,46 @@
1
+ # file list
2
+
3
+ Retrieves files from the specified folder and site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 file list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the folder from which to retrieve files is located
15
+
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the folder from which to retrieve files
18
+
19
+ `--recursive`
20
+ : Set to retrieve files from subfolders
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ This command is an improved version of the `spo file list` command. The main difference between the two commands is, that `file list` uses Microsoft Graph and properly supports retrieving files from large folders. Because `file list` uses Microsoft Graph and `spo file list` uses SharePoint REST APIs, the data returned by both commands is different.
27
+
28
+ ## Examples
29
+
30
+ Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
31
+
32
+ ```sh
33
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
34
+ ```
35
+
36
+ Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
37
+
38
+ ```sh
39
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
40
+ ```
41
+
42
+ Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
43
+
44
+ ```sh
45
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
46
+ ```
@@ -0,0 +1,30 @@
1
+ # outlook room list
2
+
3
+ Get a collection of all available rooms
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 outlook room list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--roomlistEmail [roomlistEmail]`
14
+ : Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get all the rooms
21
+
22
+ ```sh
23
+ m365 outlook room list
24
+ ```
25
+
26
+ Get all the rooms of specified roomlist e-mail address
27
+
28
+ ```sh
29
+ m365 outlook room list --roomlistEmail "bldg2@contoso.com"
30
+ ```
@@ -0,0 +1,21 @@
1
+ # outlook roomlist list
2
+
3
+ Get a collection of available roomlists
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 outlook roomlist list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Get all roomlists in your tenant
18
+
19
+ ```sh
20
+ m365 outlook roomlist list
21
+ ```
@@ -10,6 +10,12 @@ pa app list [options]
10
10
 
11
11
  ## Options
12
12
 
13
+ `-e, --environment [environment]`
14
+ : The name of the environment for which to retrieve available apps
15
+
16
+ `--asAdmin`
17
+ : Set, to list all Power Apps as admin. Otherwise will return only your own apps
18
+
13
19
  --8<-- "docs/cmd/_global.md"
14
20
 
15
21
  ## Remarks
@@ -17,10 +23,20 @@ pa app list [options]
17
23
  !!! attention
18
24
  This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
19
25
 
26
+ If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
27
+
28
+ By default, the `app list` command returns only your apps. To list all apps, use the `asAdmin` option and make sure to specify the `environment` option. You cannot specify only one of the options, when specifying the `environment` option the `asAdmin` option has to be present as well.
29
+
20
30
  ## Examples
21
31
 
22
- List all apps
32
+ List all your apps
23
33
 
24
34
  ```sh
25
35
  m365 pa app list
26
36
  ```
37
+
38
+ List all apps in a given environment
39
+
40
+ ```sh
41
+ m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
42
+ ```
@@ -0,0 +1,78 @@
1
+ # planner task add
2
+
3
+ Adds a new Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : Title of the task to add.
15
+
16
+ `--planId [planId]`
17
+ : Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
18
+
19
+ `--planName [planName]`
20
+ : Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
21
+
22
+ `--ownerGroupId [ownerGroupId]`
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
24
+
25
+ `--ownerGroupName [ownerGroupName]`
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
27
+
28
+ `--bucketId [bucketId]`
29
+ : Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
30
+
31
+ `--bucketName [bucketName]`
32
+ : Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
33
+
34
+ `--startDateTime [startDateTime]`
35
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
36
+
37
+ `--dueDateTime [dueDateTime]`
38
+ : The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
39
+
40
+ `--percentComplete [percentComplete]`
41
+ : Percentage of task completion. Number between 0 and 100.
42
+ - When set to 0, the task is considered _Not started_.
43
+ - When set between 1 and 99, the task is considered _In progress_.
44
+ - When set to 100, the task is considered _Completed_.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
+
52
+ `--description [description]`
53
+ : Description of the task
54
+
55
+ `--orderHint [orderHint]`
56
+ : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
57
+
58
+ --8<-- "docs/cmd/_global.md"
59
+
60
+ ## Examples
61
+
62
+ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
63
+
64
+ ```sh
65
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
66
+ ```
67
+
68
+ Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
69
+
70
+ ```sh
71
+ m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
72
+ ```
73
+
74
+ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
75
+
76
+ ```sh
77
+ m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
78
+ ```
@@ -0,0 +1,24 @@
1
+ # planner task details get
2
+
3
+ Retrieve the details of the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task details get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --taskId <taskId>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Retrieve the details of the specified planner task
21
+
22
+ ```sh
23
+ m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
+ ```
@@ -0,0 +1,29 @@
1
+ # planner task get
2
+
3
+ Retrieve the the specified planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task to retrieve details from
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! attention
21
+ This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
22
+
23
+ ## Examples
24
+
25
+ Retrieve the the specified planner task
26
+
27
+ ```sh
28
+ m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
29
+ ```
@@ -30,6 +30,11 @@ m365 planner task list [options]
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
33
+ ## Remarks
34
+
35
+ !!! attention
36
+ This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
37
+
33
38
  ## Examples
34
39
 
35
40
  List tasks for the currently logged in user
@@ -0,0 +1,99 @@
1
+ # planner task set
2
+
3
+ Updates a Microsoft Planner task
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner task set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the task.
15
+
16
+ `-t, --title [title]`
17
+ : New title of the task.
18
+
19
+ `--bucketId [bucketId]`
20
+ : ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
21
+
22
+ `--bucketName [bucketName]`
23
+ : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
24
+
25
+ `--planId [planId]`
26
+ : ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
27
+
28
+ `--planName [planName]`
29
+ : Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
30
+
31
+ `--ownerGroupId [ownerGroupId]`
32
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
33
+
34
+ `--ownerGroupName [ownerGroupName]`
35
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
36
+
37
+ `--startDateTime [startDateTime]`
38
+ : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
39
+
40
+ `--dueDateTime [dueDateTime]`
41
+ : The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
42
+
43
+ `--percentComplete [percentComplete]`
44
+ : Percentage of task completion. Number between 0 and 100.
45
+
46
+ `--assignedToUserIds [assignedToUserIds]`
47
+ : Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
48
+
49
+ `--assignedToUserNames [assignedToUserNames]`
50
+ : Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
+
52
+ `--description [description]`
53
+ : Description of the task
54
+
55
+ `--orderHint [orderHint]`
56
+ : Hint used to order items of this type in a list view
57
+
58
+ `--assigneePriority [assigneePriority]`
59
+ : Hint used to order items of this type in a list view
60
+
61
+ `--appliedCategories [appliedCategories]`
62
+ : Comma-separated categories that should be added to the task
63
+
64
+ --8<-- "docs/cmd/_global.md"
65
+
66
+ ## Remarks
67
+
68
+ When you specify the value for `percentageComplete`, consider the following:
69
+
70
+ - when set to 0, the task is considered _Not started_
71
+ - when set between 1 and 99, the task is considered _In progress_
72
+ - when set to 100, the task is considered _Completed_
73
+
74
+ You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
75
+
76
+ ## Examples
77
+
78
+ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
79
+
80
+ ```sh
81
+ m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
82
+ ```
83
+
84
+ Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
85
+
86
+ ```sh
87
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
88
+ ```
89
+
90
+ Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
91
+
92
+ ```sh
93
+ m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
94
+ ```
95
+
96
+ ## Additional information
97
+
98
+ - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
99
+ - Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)
@@ -0,0 +1,43 @@
1
+ # search externalconnection add
2
+
3
+ Add a new external connection to be defined for Microsoft Search
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 search externalconnection add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : Developer-provided unique ID of the connection within the Azure Active Directory tenant
15
+
16
+ `-n, --name <name>`
17
+ : The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
18
+
19
+ `-d, --description <description>`
20
+ : Description of the connection displayed in the Microsoft 365 admin center
21
+
22
+ `--authorizedAppIds [authorizedAppIds]`
23
+ : Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ The `id` must be at least 3 and no more than 32 characters long. It can contain only alphanumeric characters, can't begin with _Microsoft_ and can be any of the following values: *None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors*.
30
+
31
+ ## Examples
32
+
33
+ Adds a new external connection with name and description of test app
34
+
35
+ ```sh
36
+ m365 search externalconnection add --id MyApp --name "Test" --description "Test"
37
+ ```
38
+
39
+ Adds a new external connection with a limited number of authorized apps
40
+
41
+ ```sh
42
+ m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
43
+ ```
@@ -20,7 +20,7 @@ m365 spfx project externalize [options]
20
20
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
21
21
 
22
22
  `-o, --output [output]`
23
- : Output type. `json,text,md`. Default `text`
23
+ : Output type. `json,text,csv,md`. Default `json`
24
24
 
25
25
  `--verbose`
26
26
  : Runs command with verbose logging
@@ -23,7 +23,7 @@ m365 spfx project rename [options]
23
23
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
24
24
 
25
25
  `-o, --output [output]`
26
- : Output type. `json,text,md`. Default `text`
26
+ : Output type. `json,text,csv,md`. Default `json`
27
27
 
28
28
  `--verbose`
29
29
  : Runs command with verbose logging
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.0).
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.14.0).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -47,41 +47,41 @@ m365 spfx project upgrade --toVersion 1.5.0 --output md > "upgrade-report.md"
47
47
  Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and show the summary of the findings in the shell
48
48
 
49
49
  ```sh
50
- m365 spfx project upgrade --toVersion 1.5.0
50
+ m365 spfx project upgrade --toVersion 1.5.0 --output text
51
51
  ```
52
52
 
53
53
  Get instructions to upgrade the current SharePoint Framework project to the latest preview version
54
54
 
55
55
  ```sh
56
- m365 spfx project upgrade --preview
56
+ m365 spfx project upgrade --preview --output text
57
57
  ```
58
58
 
59
59
  Get instructions to upgrade the current SharePoint Framework project to the specified preview version
60
60
 
61
61
  ```sh
62
- m365 spfx project upgrade --toVersion 1.12.1-rc.0
62
+ m365 spfx project upgrade --toVersion 1.12.1-rc.0 --output text
63
63
  ```
64
64
 
65
65
  Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using pnpm
66
66
 
67
67
  ```sh
68
- m365 spfx project upgrade --packageManager pnpm
68
+ m365 spfx project upgrade --packageManager pnpm --output text
69
69
  ```
70
70
 
71
71
  Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365
72
72
 
73
73
  ```sh
74
- m365 spfx project upgrade
74
+ m365 spfx project upgrade --output text
75
75
  ```
76
76
 
77
77
  Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using PowerShell
78
78
 
79
79
  ```sh
80
- m365 spfx project upgrade --shell powershell
80
+ m365 spfx project upgrade --shell powershell --output text
81
81
  ```
82
82
 
83
83
  Get instructions to upgrade the current SharePoint Framework project to the latest version of SharePoint Framework and save the findings in a [CodeTour](https://aka.ms/codetour) file
84
84
 
85
85
  ```sh
86
- m365 spfx project upgrade --output tour
86
+ m365 spfx project upgrade --output tour
87
87
  ```
@@ -20,7 +20,7 @@ m365 spfx doctor [options]
20
20
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
21
21
 
22
22
  `-o, --output [output]`
23
- : Output type. `json,text,md`. Default `text`
23
+ : Output type. `json,text,csv,md`. Default `json`
24
24
 
25
25
  `--verbose`
26
26
  : Runs command with verbose logging
@@ -0,0 +1,33 @@
1
+ # spo contenttype list
2
+
3
+ Lists content types from specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo contenttype list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site for which to list content types
15
+
16
+ `-c, --category [category]`
17
+ : Category name of content types. When defined will return only content types from specified category
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve site content types
24
+
25
+ ```PowerShell
26
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
27
+ ```
28
+
29
+ Retrieve site content types from the 'List Content Types' category
30
+
31
+ ```PowerShell
32
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
33
+ ```
@@ -13,24 +13,46 @@ m365 spo group user add [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the SharePoint group is available
15
15
 
16
- `--groupId <groupId>`
17
- : Id of the SharePoint Group to which user needs to be added
16
+ `--groupId [groupId]`
17
+ : Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
18
18
 
19
- `--userName <userName>`
20
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com)
19
+ `--groupName [groupName]`
20
+ : Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
21
+
22
+ `--userName [userName]`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
24
+
25
+ `--email [email]`
26
+ : User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
33
+
24
34
  ## Examples
25
35
 
26
- Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
36
+ Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
27
37
 
28
38
  ```sh
29
39
  m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
30
40
  ```
31
41
 
32
- Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
42
+ Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
33
43
 
34
44
  ```sh
35
45
  m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
36
46
  ```
47
+
48
+ Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
49
+
50
+ ```sh
51
+ m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
52
+ ```
53
+
54
+ Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
55
+
56
+ ```sh
57
+ m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
58
+ ```