@pnp/cli-microsoft365 6.0.0-beta.a008afc → 6.0.0-beta.a2ec37b

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 (161) 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 +36 -13
  4. package/dist/m365/aad/commands/app/app-list.js +38 -0
  5. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  6. package/dist/m365/aad/commands.js +2 -0
  7. package/dist/m365/commands/status.js +6 -1
  8. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  9. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  10. package/dist/m365/outlook/commands.js +1 -0
  11. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  12. package/dist/m365/planner/commands/plan/plan-get.js +5 -20
  13. package/dist/m365/pp/commands/card/card-get.js +110 -0
  14. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  15. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  16. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  17. package/dist/m365/pp/commands.js +4 -0
  18. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  19. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  25. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  26. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  27. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  28. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  29. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  30. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  31. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  32. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  33. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  34. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  35. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  36. package/dist/m365/spo/commands/field/field-add.js +26 -1
  37. package/dist/m365/spo/commands/field/field-set.js +23 -13
  38. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  39. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  40. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  41. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  42. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  43. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +14 -6
  44. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  45. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  46. package/dist/m365/spo/commands/list/list-webhook-list.js +17 -42
  47. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  48. package/dist/m365/spo/commands/list/list-webhook-set.js +27 -20
  49. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  50. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  51. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  52. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  53. package/dist/m365/spo/commands/listitem/listitem-list.js +21 -11
  54. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  55. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  56. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  57. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  58. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  59. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  60. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  61. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  62. package/dist/m365/spo/commands/site/site-add.js +4 -11
  63. package/dist/m365/spo/commands/{hubsite/hubsite-connect.js → site/site-hubsite-connect.js} +10 -10
  64. package/dist/m365/spo/commands/{hubsite/hubsite-disconnect.js → site/site-hubsite-disconnect.js} +13 -13
  65. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  66. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  67. package/dist/m365/spo/commands.js +5 -3
  68. package/dist/m365/teams/commands/team/team-set.js +0 -7
  69. package/dist/m365/todo/commands/list/list-get.js +89 -0
  70. package/dist/m365/todo/commands/task/task-add.js +55 -3
  71. package/dist/m365/todo/commands/task/task-get.js +108 -0
  72. package/dist/m365/todo/commands/task/task-set.js +53 -1
  73. package/dist/m365/todo/commands.js +2 -0
  74. package/docs/docs/_clisettings.md +18 -0
  75. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  76. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  77. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +3 -0
  78. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  79. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  80. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  81. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  82. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  83. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  84. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  85. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  86. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  87. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  88. package/docs/docs/cmd/planner/plan/plan-get.md +75 -6
  89. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  90. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  91. package/docs/docs/cmd/planner/task/task-get.md +0 -3
  92. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  93. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  94. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  95. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  96. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  97. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  98. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  99. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  100. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  101. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  102. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  103. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  104. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  105. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  106. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  107. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  108. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  109. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  110. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  111. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  112. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  113. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +16 -7
  114. package/docs/docs/cmd/spo/list/list-view-set.md +14 -3
  115. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  116. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  117. package/docs/docs/cmd/spo/list/list-webhook-list.md +13 -10
  118. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  119. package/docs/docs/cmd/spo/list/list-webhook-set.md +21 -12
  120. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  121. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  122. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  123. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  124. package/docs/docs/cmd/spo/listitem/listitem-list.md +10 -1
  125. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  126. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  127. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  128. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  129. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  130. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  131. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  132. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +5 -10
  133. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  134. package/docs/docs/cmd/spo/site/site-add.md +0 -3
  135. package/docs/docs/cmd/spo/{hubsite/hubsite-connect.md → site/site-hubsite-connect.md} +4 -4
  136. package/docs/docs/cmd/spo/{hubsite/hubsite-disconnect.md → site/site-hubsite-disconnect.md} +7 -7
  137. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  138. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  139. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  140. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  141. package/docs/docs/cmd/teams/team/team-clone.md +0 -3
  142. package/docs/docs/cmd/teams/team/team-set.md +0 -3
  143. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  144. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  145. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  146. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  147. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  148. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  149. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  150. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  151. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  152. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  153. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  154. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  155. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  156. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  157. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  158. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  159. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  160. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  161. package/package.json +13 -4
@@ -0,0 +1,107 @@
1
+ # aad user guest add
2
+
3
+ Invite an external user to the organization
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user guest add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--emailAddress <emailAddress>`
14
+ : The email address of the user.
15
+
16
+ `--displayName [displayName]`
17
+ : The display name of the user.
18
+
19
+ `--inviteRedirectUrl [inviteRedirectUrl]`
20
+ : The URL the user should be redirected to once the invitation is redeemed. If not specified, default URL https://myapplications.microsoft.com will be set.
21
+
22
+ `--welcomeMessage [welcomeMessage]`
23
+ : Personal welcome message which will be added to the email along with the default email.
24
+
25
+ `--ccRecipients [ccRecipients]`
26
+ : Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.
27
+
28
+ `--messageLanguage [messageLanguage]`
29
+ : The language you want to send the default message in. The language format should be in [ISO 639](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/ed06cf15-306c-43be-9053-ca81ca51e656). The default is `en-US`.
30
+
31
+ `--sendInvitationMessage`
32
+ : Indicates whether an email should be sent to the user.
33
+
34
+ --8<-- "docs/cmd/_global.md"
35
+
36
+ ## Examples
37
+
38
+ Invite a user via email and set the display name
39
+
40
+ ```sh
41
+ m365 aad user guest add --emailAddress john.doe@contoso.com --displayName "John Doe" --sendInvitationMessage
42
+ ```
43
+
44
+ Invite a user with a custom email and custom redirect url
45
+
46
+ ```sh
47
+ m365 aad user guest add --emailAddress john.doe@contoso.com --welcomeMessage "Hi John, welcome to the organization!" --sendInvitationMessage
48
+ ```
49
+
50
+ Invite a user and send an invitation mail in Dutch
51
+
52
+ ```sh
53
+ m365 aad user guest add --emailAddress john.doe@contoso.com --messageLanguage nl-BE --sendInvitationMessage
54
+ ```
55
+
56
+ ## Response
57
+
58
+ === "JSON"
59
+
60
+ ```json
61
+ {
62
+ "id": "35f7f726-c541-4aef-a64e-a7b6868fe47f",
63
+ "inviteRedeemUrl": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0",
64
+ "invitedUserDisplayName": "John Doe",
65
+ "invitedUserType": "Guest",
66
+ "invitedUserEmailAddress": "john.doe@contoso.com",
67
+ "sendInvitationMessage": true,
68
+ "resetRedemption": false,
69
+ "inviteRedirectUrl": "https://myapplications.microsoft.com/",
70
+ "status": "PendingAcceptance",
71
+ "invitedUserMessageInfo": {
72
+ "messageLanguage": "en-US",
73
+ "customizedMessageBody": "Hi John, welcome to the organization!",
74
+ "ccRecipients": [
75
+ {
76
+ "emailAddress": {
77
+ "name": null,
78
+ "address": "maria.jones@contoso.com"
79
+ }
80
+ }
81
+ ]
82
+ },
83
+ "invitedUser": {
84
+ "id": "5257b5b2-4056-4a45-a05e-df5c92d53e6e"
85
+ }
86
+ }
87
+ ```
88
+
89
+ === "Text"
90
+
91
+ ```text
92
+ id : 35f7f726-c541-4aef-a64e-a7b6868fe47f
93
+ inviteRedeemUrl : https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0
94
+ invitedUserDisplayName : John Doe
95
+ invitedUserEmailAddress: liwidit556@adroh.com
96
+ invitedUserType : Guest
97
+ resetRedemption : false
98
+ sendInvitationMessage : true
99
+ status : PendingAcceptance
100
+ ```
101
+
102
+ === "CSV"
103
+
104
+ ```csv
105
+ id,inviteRedeemUrl,invitedUserDisplayName,invitedUserEmailAddress,invitedUserType,resetRedemption,sendInvitationMessage,status
106
+ 35f7f726-c541-4aef-a64e-a7b6868fe47f,https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0,John Doe,liwidit556@adroh.com,Guest,,1,PendingAcceptance
107
+ ```
@@ -43,6 +43,9 @@ The predefined card is automatically adjusted based on which options have been s
43
43
 
44
44
  If your custom card is a card template (card with placeholders like `${title}`), you can fill it with data either by specifying the complete data object using the `cardData` option, or by passing any number of arbitrary options that will be mapped onto the card. The arbitrary properties should not match any of the global options like `output`, `query`, `debug`, etc. Data options like `title`, `description`, `imageUrl` and `actionUrl` will be mapped onto the card as well.
45
45
 
46
+ !!! warning "Escaping JSON in PowerShell"
47
+ When using the `--card` and `--cardData` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
48
+
46
49
  ## Examples
47
50
 
48
51
  Send a predefined adaptive card with just title
@@ -43,26 +43,19 @@ The schema extension owner is the ID of the Azure AD application that is the own
43
43
 
44
44
  The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list
45
45
 
46
- When specifying the JSON string of properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _properties_ option: `{"Foo":"Bar"}`,
47
- you should specify the value as <code>\`"{""Foo"":""Bar""}"\`</code>.
48
- In addition, when using PowerShell, you should use the `--%` argument.
46
+ !!! warning "Escaping JSON in PowerShell"
47
+ When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
49
48
 
50
49
  ## Examples
51
50
 
52
51
  Create a schema extension
53
52
 
54
53
  ```sh
55
- m365 graph schemaextension add --id MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
54
+ m365 graph schemaextension add --id MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
56
55
  ```
57
56
 
58
57
  Create a schema extension with a verified domain
59
58
 
60
59
  ```sh
61
- m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
62
- ```
63
-
64
- Create a schema extension in PowerShell
65
-
66
- ```PowerShell
67
- graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner "62375ab9-6b52-47ed-826b-58e47e0e304b" --properties --% \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
60
+ m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
68
61
  ```
@@ -35,9 +35,9 @@ m365 graph schemaextension set [options]
35
35
  The lifecycle state of the schema extension. The initial state upon creation is `InDevelopment`.
36
36
  Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`.
37
37
  The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list.
38
- When specifying the JSON string of properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _properties_ option: `{"Foo":"Bar"}`,
39
- you should specify the value as <code>\`"{""Foo"":""Bar""}"\`</code>.
40
- In addition, when using PowerShell, you should use the `--%` argument.
38
+
39
+ !!! warning "Escaping JSON in PowerShell"
40
+ When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
41
41
 
42
42
  ## Examples
43
43
 
@@ -50,13 +50,7 @@ m365 graph schemaextension set --id MySchemaExtension --owner 62375ab9-6b52-47ed
50
50
  Update the target types and properties of a schema extension
51
51
 
52
52
  ```sh
53
- m365 graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --targetTypes "Group,User" --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
54
- ```
55
-
56
- Update the properties of a schema extension in PowerShell
57
-
58
- ```PowerShell
59
- graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties --% \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
53
+ m365 graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --targetTypes "Group,User" --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
60
54
  ```
61
55
 
62
56
  Change the status of a schema extension to 'Available'
@@ -37,6 +37,9 @@ m365 outlook mail send [options]
37
37
  `--importance [importance]`
38
38
  : The importance of the message. Available options: `low`, `normal` or `high`. Default is `normal`.
39
39
 
40
+ `--attachment [attachment]`
41
+ : Path to the file that will be added as attachment to the email. This option can be used multiple times to attach multiple attachments.
42
+
40
43
  `--saveToSentItems [saveToSentItems]`
41
44
  : Save email in the sent items folder. Default `true`.
42
45
 
@@ -44,6 +47,10 @@ m365 outlook mail send [options]
44
47
 
45
48
  ## Remarks
46
49
 
50
+ ### Attachments
51
+
52
+ When using the `attachment` option, note that the total size of all attachment files cannot exceed 3 MB.
53
+
47
54
  ### If you are connected using app only authentication
48
55
 
49
56
  - Always specify a user id or upn in the `--sender` option. The email will be sent as if it came from the specified user, and can optionally be saved in the sent folder of that user account.
@@ -110,3 +117,9 @@ Send an email with cc and bcc recipients marked as important
110
117
  ```sh
111
118
  m365 outlook mail send --to chris@contoso.com --cc claire@contoso.com --bcc randy@contoso.com --subject "DG2000 Data Sheets" --bodyContents "The latest data sheets are in the team site" --importance high
112
119
  ```
120
+
121
+ Send an email with multiple attachments
122
+
123
+ ```sh
124
+ m365 outlook mail send --to chris@contoso.com --subject "Monthly reports" --bodyContents "Here are the reports of this month." --attachment "C:/Reports/File1.jpg" --attachment "C:/Reports/File2.docx" --attachment "C:/Reports/File3.xlsx"
125
+ ```
@@ -0,0 +1,48 @@
1
+ # outlook message get
2
+
3
+ Retrieves specified message
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 outlook message get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the message
15
+
16
+ `--userId [userId]`
17
+ : ID of the user from which to retrieve the message. Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
18
+
19
+ `--userPrincipalName [userPrincipalName]`
20
+ : UPN of the user from which to retrieve the message Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Examples
25
+
26
+ Get a specific message using delegated permissions
27
+
28
+ ```sh
29
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA=
30
+ ```
31
+
32
+ Get a specific message using delegated permissions from a shared mailbox
33
+
34
+ ```sh
35
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName sharedmailbox@tenant.com
36
+ ```
37
+
38
+ Get a specific message from a specific user retrieved by user ID using application permissions
39
+
40
+ ```sh
41
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userId 6799fd1a-723b-4eb7-8e52-41ae530274ca
42
+ ```
43
+
44
+ Get a specific message from a specific user retrieved by user principal name using application permissions
45
+
46
+ ```sh
47
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName user@tenant.com
48
+ ```
@@ -43,3 +43,32 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
43
43
  ```sh
44
44
  m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
45
  ```
46
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ {
53
+ "name": "My Planner Bucket",
54
+ "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
55
+ "orderHint": "8585363889524958496",
56
+ "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
57
+ }
58
+ ```
59
+
60
+ === "Text"
61
+
62
+ ```text
63
+ id : ttEB_Uj690STdR3GC1MIDZgANq1U
64
+ name : My Planner Bucket
65
+ orderHint: 8585363889524958496
66
+ planId : xqQg5FS2LkCp935s-FIFm2QAFkHM
67
+ ```
68
+
69
+ === "CSV"
70
+
71
+ ```csv
72
+ id,name,planId,orderHint
73
+ ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
74
+ ```
@@ -55,3 +55,32 @@ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40f
55
55
  ```sh
56
56
  m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ === "JSON"
62
+
63
+ ```json
64
+ {
65
+ "name": "My Planner Bucket",
66
+ "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
67
+ "orderHint": "8585363889524958496",
68
+ "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
69
+ }
70
+ ```
71
+
72
+ === "Text"
73
+
74
+ ```text
75
+ id : ttEB_Uj690STdR3GC1MIDZgANq1U
76
+ name : My Planner Bucket
77
+ orderHint: 8585363889524958496
78
+ planId : xqQg5FS2LkCp935s-FIFm2QAFkHM
79
+ ```
80
+
81
+ === "CSV"
82
+
83
+ ```csv
84
+ id,name,planId,orderHint
85
+ ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
86
+ ```
@@ -37,3 +37,33 @@ Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Gro
37
37
  ```sh
38
38
  m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
39
  ```
40
+
41
+ ## Response
42
+
43
+ === "JSON"
44
+
45
+ ```json
46
+ [
47
+ {
48
+ "name": "My Planner Bucket",
49
+ "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
50
+ "orderHint": "8585363889524958496",
51
+ "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
52
+ }
53
+ ]
54
+ ```
55
+
56
+ === "Text"
57
+
58
+ ```text
59
+ id name planId orderHint
60
+ ---------------------------- ----------------- ---------------------------- -------------------
61
+ ttEB_Uj690STdR3GC1MIDZgANq1U My Planner Bucket xqQg5FS2LkCp935s-FIFm2QAFkHM 8585363889524958496
62
+ ```
63
+
64
+ === "CSV"
65
+
66
+ ```csv
67
+ id,name,planId,orderHint
68
+ ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
69
+ ```
@@ -58,3 +58,7 @@ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_
58
58
  ```sh
59
59
  m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
60
  ```
61
+
62
+ ## Response
63
+
64
+ The command won't return a response on success.
@@ -55,3 +55,7 @@ Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ own
55
55
  ```sh
56
56
  m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ The command won't return a response on success.
@@ -50,3 +50,126 @@ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Plan
50
50
  ```sh
51
51
  m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
52
52
  ```
53
+
54
+ ## Response
55
+
56
+ ### Standard response
57
+
58
+ === "JSON"
59
+
60
+ ``` json
61
+ {
62
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
63
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
64
+ "title": "My Planner Plan",
65
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
66
+ "createdBy": {
67
+ "user": {
68
+ "displayName": null,
69
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
70
+ },
71
+ "application": {
72
+ "displayName": null,
73
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
74
+ }
75
+ },
76
+ "container": {
77
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
78
+ "type": "group",
79
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
80
+ }
81
+ }
82
+ ```
83
+
84
+ === "Text"
85
+
86
+ ``` text
87
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
88
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
89
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
90
+ title : My Planner Plan
91
+ ```
92
+
93
+ === "CSV"
94
+
95
+ ``` text
96
+ id,title,createdDateTime,owner
97
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
98
+ ```
99
+
100
+ ### `shareWithUserIds`, `shareWithUserNames` response
101
+
102
+ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ.
103
+
104
+ === "JSON"
105
+
106
+ ```json
107
+ {
108
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
109
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
110
+ "title": "My Planner Plan",
111
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
112
+ "createdBy": {
113
+ "user": {
114
+ "displayName": null,
115
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
116
+ },
117
+ "application": {
118
+ "displayName": null,
119
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
120
+ }
121
+ },
122
+ "container": {
123
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
124
+ "type": "group",
125
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
126
+ },
127
+ "sharedWith": {
128
+ "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
129
+ "6463a5ce-2119-4198-9f2a-628761df4a62": true
130
+ },
131
+ "categoryDescriptions": {
132
+ "category1": null,
133
+ "category2": null,
134
+ "category3": null,
135
+ "category4": null,
136
+ "category5": null,
137
+ "category6": null,
138
+ "category7": null,
139
+ "category8": null,
140
+ "category9": null,
141
+ "category10": null,
142
+ "category11": null,
143
+ "category12": null,
144
+ "category13": null,
145
+ "category14": null,
146
+ "category15": null,
147
+ "category16": null,
148
+ "category17": null,
149
+ "category18": null,
150
+ "category19": null,
151
+ "category20": null,
152
+ "category21": null,
153
+ "category22": null,
154
+ "category23": null,
155
+ "category24": null,
156
+ "category25": null
157
+ }
158
+ }
159
+ ```
160
+
161
+ === "Text"
162
+
163
+ ```text
164
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
165
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
166
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
167
+ title : My Planner Plan
168
+ ```
169
+
170
+ === "CSV"
171
+
172
+ ```csv
173
+ id,title,createdDateTime,owner
174
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
175
+ ```
@@ -16,12 +16,6 @@ m365 planner plan get [options]
16
16
  `-t, --title [title]`
17
17
  : Title of the plan. Specify either `id` or `title` but not both.
18
18
 
19
- `--planId [planId]`
20
- : (deprecated. Use `id` instead) ID of the plan. Specify either `planId` or `planTitle` but not both.
21
-
22
- `---planTitle [planTitle]`
23
- : (deprecated. Use `title` instead) Title of the plan. Specify either `planId` or `planTitle` but not both.
24
-
25
19
  `--ownerGroupId [ownerGroupId]`
26
20
  : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
27
21
 
@@ -49,3 +43,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
49
43
  ```sh
50
44
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
51
45
  ```
46
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ {
53
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
54
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
55
+ "title": "My Planner Plan",
56
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
57
+ "createdBy": {
58
+ "user": {
59
+ "displayName": null,
60
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
61
+ },
62
+ "application": {
63
+ "displayName": null,
64
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
65
+ }
66
+ },
67
+ "container": {
68
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
69
+ "type": "group",
70
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
71
+ },
72
+ "sharedWith": {
73
+ "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
74
+ "6463a5ce-2119-4198-9f2a-628761df4a62": true
75
+ },
76
+ "categoryDescriptions": {
77
+ "category1": null,
78
+ "category2": null,
79
+ "category3": null,
80
+ "category4": null,
81
+ "category5": null,
82
+ "category6": null,
83
+ "category7": null,
84
+ "category8": null,
85
+ "category9": null,
86
+ "category10": null,
87
+ "category11": null,
88
+ "category12": null,
89
+ "category13": null,
90
+ "category14": null,
91
+ "category15": null,
92
+ "category16": null,
93
+ "category17": null,
94
+ "category18": null,
95
+ "category19": null,
96
+ "category20": null,
97
+ "category21": null,
98
+ "category22": null,
99
+ "category23": null,
100
+ "category24": null,
101
+ "category25": null
102
+ }
103
+ }
104
+ ```
105
+
106
+ === "Text"
107
+
108
+ ```text
109
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
110
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
111
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
112
+ title : My Planner Plan
113
+ ```
114
+
115
+ === "CSV"
116
+
117
+ ```csv
118
+ id,title,createdDateTime,owner
119
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
120
+ ```
@@ -31,3 +31,48 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
31
31
  ```sh
32
32
  m365 planner plan list --ownerGroupName "My Planner Group"
33
33
  ```
34
+
35
+ ## Response
36
+
37
+ === "JSON"
38
+
39
+ ```json
40
+ [
41
+ {
42
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
43
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
44
+ "title": "My Planner Plan",
45
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
46
+ "createdBy": {
47
+ "user": {
48
+ "displayName": null,
49
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
50
+ },
51
+ "application": {
52
+ "displayName": null,
53
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
54
+ }
55
+ },
56
+ "container": {
57
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
58
+ "type": "group",
59
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
60
+ }
61
+ }
62
+ ]
63
+ ```
64
+
65
+ === "Text"
66
+
67
+ ```text
68
+ id title createdDateTime owner
69
+ ---------------------------- --------------- ---------------------------- ------------------------------------
70
+ xqQg5FS2LkCp935s-FIFm2QAFkHM My Planner Plan 2015-03-30T18:36:49.2407981Z ebf3b108-5234-4e22-b93d-656d7dae5874
71
+ ```
72
+
73
+ === "CSV"
74
+
75
+ ```csv
76
+ id,title,createdDateTime,owner
77
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
78
+ ```
@@ -46,3 +46,7 @@ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My P
46
46
  ```sh
47
47
  m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
48
48
  ```
49
+
50
+ ## Response
51
+
52
+ The command won't return a response on success.
@@ -22,9 +22,6 @@ m365 planner task details get [options]
22
22
  `-t, --title [title]`
23
23
  : Title of the task. Specify either `id` or `title` but not both.
24
24
 
25
- `--taskId [taskId]`
26
- : (deprecated. Use `id` instead) ID of the task.
27
-
28
25
  `--bucketId [bucketId]`
29
26
  : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
30
27