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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/.eslintrc.js +4 -2
  2. package/dist/Command.js +16 -2
  3. package/dist/m365/aad/commands/app/app-add.js +37 -13
  4. package/dist/m365/commands/status.js +6 -1
  5. package/dist/m365/outlook/commands/mail/mail-send.js +55 -31
  6. package/dist/m365/planner/commands/bucket/bucket-get.js +1 -1
  7. package/dist/m365/pp/commands/Environment.js +3 -0
  8. package/dist/m365/pp/commands/card/card-get.js +110 -0
  9. package/dist/m365/pp/commands/environment/environment-get.js +75 -0
  10. package/dist/m365/pp/commands/gateway/gateway-get.js +70 -0
  11. package/dist/m365/pp/commands/solution/solution-get.js +117 -0
  12. package/dist/m365/pp/commands.js +4 -0
  13. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  14. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  15. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  16. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  22. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  23. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  26. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  27. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  28. package/dist/m365/spo/commands/contenttype/contenttype-add.js +82 -43
  29. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +53 -21
  30. package/dist/m365/spo/commands/contenttype/contenttype-get.js +35 -14
  31. package/dist/m365/spo/commands/field/field-add.js +26 -1
  32. package/dist/m365/spo/commands/field/field-set.js +23 -13
  33. package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +168 -0
  34. package/dist/m365/spo/commands/list/list-contenttype-add.js +21 -18
  35. package/dist/m365/spo/commands/list/list-contenttype-default-set.js +59 -47
  36. package/dist/m365/spo/commands/list/list-contenttype-list.js +16 -8
  37. package/dist/m365/spo/commands/list/list-contenttype-remove.js +16 -8
  38. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  39. package/dist/m365/spo/commands/list/list-roleinheritance-break.js +14 -6
  40. package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +15 -7
  41. package/dist/m365/spo/commands/list/list-webhook-add.js +19 -11
  42. package/dist/m365/spo/commands/list/list-webhook-get.js +17 -10
  43. package/dist/m365/spo/commands/list/list-webhook-list.js +23 -24
  44. package/dist/m365/spo/commands/list/list-webhook-remove.js +19 -11
  45. package/dist/m365/spo/commands/list/list-webhook-set.js +18 -10
  46. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  47. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  48. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  49. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  50. package/dist/m365/spo/commands/listitem/listitem-list.js +27 -11
  51. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  52. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  53. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  54. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  55. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  56. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +14 -6
  57. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  58. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  59. package/dist/m365/spo/commands.js +3 -0
  60. package/dist/m365/todo/commands/list/list-get.js +89 -0
  61. package/dist/m365/todo/commands/task/task-add.js +55 -3
  62. package/dist/m365/todo/commands/task/task-get.js +108 -0
  63. package/dist/m365/todo/commands/task/task-set.js +53 -1
  64. package/dist/m365/todo/commands.js +2 -0
  65. package/docs/docs/_clisettings.md +19 -0
  66. package/docs/docs/cmd/outlook/mail/mail-send.md +13 -0
  67. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  68. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  69. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  70. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  71. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  72. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  73. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  74. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  75. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  76. package/docs/docs/cmd/pp/card/card-get.md +51 -0
  77. package/docs/docs/cmd/pp/environment/environment-get.md +38 -0
  78. package/docs/docs/cmd/pp/gateway/gateway-get.md +24 -0
  79. package/docs/docs/cmd/pp/solution/solution-get.md +51 -0
  80. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  81. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  82. package/docs/docs/cmd/spo/contenttype/contenttype-add.md +20 -2
  83. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.md +22 -4
  84. package/docs/docs/cmd/spo/contenttype/contenttype-get.md +21 -3
  85. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +2 -2
  86. package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md +2 -2
  87. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  88. package/docs/docs/cmd/spo/field/field-set.md +11 -2
  89. package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.md +57 -0
  90. package/docs/docs/cmd/spo/list/list-contenttype-add.md +16 -7
  91. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +16 -7
  92. package/docs/docs/cmd/spo/list/list-contenttype-list.md +15 -6
  93. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +17 -8
  94. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +11 -8
  95. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +14 -5
  96. package/docs/docs/cmd/spo/list/list-webhook-add.md +15 -16
  97. package/docs/docs/cmd/spo/list/list-webhook-get.md +16 -7
  98. package/docs/docs/cmd/spo/list/list-webhook-list.md +16 -7
  99. package/docs/docs/cmd/spo/list/list-webhook-remove.md +12 -10
  100. package/docs/docs/cmd/spo/list/list-webhook-set.md +14 -12
  101. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  102. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  103. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  104. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  105. package/docs/docs/cmd/spo/listitem/listitem-list.md +12 -3
  106. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  107. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  108. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  109. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  110. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  111. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +11 -2
  112. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  113. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  114. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  115. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  116. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  117. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  118. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  119. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  120. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  121. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  122. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  123. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  124. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  125. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  126. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  127. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  128. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  129. package/docs/docs/cmd/todo/task/task-add.md +32 -5
  130. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  131. package/docs/docs/cmd/todo/task/task-set.md +29 -2
  132. package/package.json +12 -4
@@ -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
+ ```
@@ -55,3 +55,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
55
55
  ```sh
56
56
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ === "JSON"
62
+
63
+ ```json
64
+ {
65
+ "createdDateTime": "2015-03-30T18:36:49.2407981Z",
66
+ "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
67
+ "title": "My Planner Plan",
68
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
69
+ "createdBy": {
70
+ "user": {
71
+ "displayName": null,
72
+ "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
73
+ },
74
+ "application": {
75
+ "displayName": null,
76
+ "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
77
+ }
78
+ },
79
+ "container": {
80
+ "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
81
+ "type": "group",
82
+ "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
83
+ },
84
+ "sharedWith": {
85
+ "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
86
+ "6463a5ce-2119-4198-9f2a-628761df4a62": true
87
+ },
88
+ "categoryDescriptions": {
89
+ "category1": null,
90
+ "category2": null,
91
+ "category3": null,
92
+ "category4": null,
93
+ "category5": null,
94
+ "category6": null,
95
+ "category7": null,
96
+ "category8": null,
97
+ "category9": null,
98
+ "category10": null,
99
+ "category11": null,
100
+ "category12": null,
101
+ "category13": null,
102
+ "category14": null,
103
+ "category15": null,
104
+ "category16": null,
105
+ "category17": null,
106
+ "category18": null,
107
+ "category19": null,
108
+ "category20": null,
109
+ "category21": null,
110
+ "category22": null,
111
+ "category23": null,
112
+ "category24": null,
113
+ "category25": null
114
+ }
115
+ }
116
+ ```
117
+
118
+ === "Text"
119
+
120
+ ```text
121
+ createdDateTime: 2015-03-30T18:36:49.2407981Z
122
+ id : xqQg5FS2LkCp935s-FIFm2QAFkHM
123
+ owner : ebf3b108-5234-4e22-b93d-656d7dae5874
124
+ title : My Planner Plan
125
+ ```
126
+
127
+ === "CSV"
128
+
129
+ ```csv
130
+ id,title,createdDateTime,owner
131
+ xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
132
+ ```
@@ -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.
@@ -0,0 +1,51 @@
1
+ # pp card get
2
+
3
+ Gets a specific Microsoft Power Platform card in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ pp card get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i, --id [id]`
17
+ : The id of the card. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The name of the card. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Get a specific card in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card"
33
+ ```
34
+
35
+ Get a specific card in a specific environment based on name as admin
36
+
37
+ ```sh
38
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --asAdmin
39
+ ```
40
+
41
+ Get a specific card in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa"
45
+ ```
46
+
47
+ Get a specific card in a specific environment based on id as admin
48
+
49
+ ```sh
50
+ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --asAdmin
51
+ ```
@@ -0,0 +1,38 @@
1
+ # pp environment get
2
+
3
+ Gets information about the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp environment get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --name <name>`
14
+ : The name of the environment to get information about
15
+
16
+ `-a, --asAdmin`
17
+ : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
18
+
19
+ ## Remarks
20
+
21
+ !!! attention
22
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
23
+ Register CLI for Microsoft 365 or Azure AD application as a management application for the Power Platform using
24
+ m365 pp managementapp add [options]
25
+
26
+ ## Examples
27
+
28
+ Get information about the Power Platform environment by name
29
+
30
+ ```sh
31
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
32
+ ```
33
+
34
+ Get information as admin about the Power Platform environment by name
35
+
36
+ ```sh
37
+ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
38
+ ```
@@ -0,0 +1,24 @@
1
+ # pp gateway get
2
+
3
+ Get information about the specified gateway
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp gateway get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : ID of the Gateway.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Examples
19
+
20
+ Get information about the specified gateway.
21
+
22
+ ```sh
23
+ m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
24
+ ```
@@ -0,0 +1,51 @@
1
+ # pp solution get
2
+
3
+ Gets a specific solution in a given environment.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp solution get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environment <environment>`
14
+ : The name of the environment.
15
+
16
+ `-i --id [id]`
17
+ : The ID of the solution. Specify either `id` or `name` but not both.
18
+
19
+ `-n, --name [name]`
20
+ : The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
21
+
22
+ `-a, --asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Gets a specific solution in a specific environment based on name
30
+
31
+ ```sh
32
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
33
+ ```
34
+
35
+ Gets a specific solution in a specific environment based on name as Admin
36
+
37
+ ```sh
38
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
39
+ ```
40
+
41
+ Gets a specific solution in a specific environment based on id
42
+
43
+ ```sh
44
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
45
+ ```
46
+
47
+ Gets a specific solution in a specific environment based on id as Admin
48
+
49
+ ```sh
50
+ m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
51
+ ```
@@ -16,20 +16,7 @@ m365 spfx project rename [options]
16
16
  `--generateNewId`
17
17
  : Generate a new solution ID for the project
18
18
 
19
- `-h, --help`
20
- : output usage information
21
-
22
- `--query [query]`
23
- : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
24
-
25
- `-o, --output [output]`
26
- : Output type. `json,text,csv,md`. Default `json`
27
-
28
- `--verbose`
29
- : Runs command with verbose logging
30
-
31
- `--debug`
32
- : Runs command with debug logging
19
+ --8<-- "docs/cmd/_global.md"
33
20
 
34
21
  !!! important
35
22
  Run this command in the folder where the project that you want to rename is located.
@@ -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.16.0-beta.1).
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.16.0-beta.2).
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
 
@@ -14,7 +14,13 @@ m365 spo contenttype add [options]
14
14
  : Absolute URL of the site where the content type should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type should be created (if it should be created as a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id <id>`
20
26
  : The ID of the content type. Determines the parent content type
@@ -44,12 +50,24 @@ Create a site content type that inherits from the List item content type
44
50
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
45
51
  ```
46
52
 
47
- Create a list content type that inherits from the List item content type
53
+ Create a list (retrieved by Title) content type that inherits from the List item content type
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
51
57
  ```
52
58
 
59
+ Create a list (retrieved by ID) content type that inherits from the List item content type
60
+
61
+ ```sh
62
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
63
+ ```
64
+
65
+ Create a list (retrieved by URL) content type that inherits from the List item content type
66
+
67
+ ```sh
68
+ m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
69
+ ```
70
+
53
71
  ## More information
54
72
 
55
73
  - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))
@@ -14,7 +14,13 @@ m365 spo contenttype field remove [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --contentTypeId <contentTypeId>`
20
26
  : The ID of the content type to remove the column from
@@ -32,20 +38,32 @@ m365 spo contenttype field remove [options]
32
38
 
33
39
  ## Examples
34
40
 
35
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
41
+ Remove column with a specific ID from a content type with a specific ID from a specific site.
36
42
 
37
43
  ```sh
38
44
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
39
45
  ```
40
46
 
41
- Remove column with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_ updating child content types
47
+ Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
42
48
 
43
49
  ```sh
44
50
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
45
51
  ```
46
52
 
47
- Remove fieldLink with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ from list content type with ID _0x0100CA0FA0F5DAEF784494B9C6020C3020A6_ from web with URL _https://contoso.sharepoint.com_
53
+ Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
48
54
 
49
55
  ```sh
50
56
  m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
51
57
  ```
58
+
59
+ Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
60
+
61
+ ```sh
62
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
63
+ ```
64
+
65
+ Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
66
+
67
+ ```sh
68
+ m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
69
+ ```
@@ -14,7 +14,13 @@ m365 spo contenttype get [options]
14
14
  : Absolute URL of the site where the content type is located
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the content type is located (if it is a list content type)
17
+ : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
+
19
+ `--listId [listId]`
20
+ : ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
18
24
 
19
25
  `-i, --id [id]`
20
26
  : The ID of the content type to retrieve. Specify either id or name but not both
@@ -39,11 +45,23 @@ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-s
39
45
  Retrieve site content type by name
40
46
 
41
47
  ```sh
42
- m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name "Document"
48
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
43
49
  ```
44
50
 
45
- Retrieve list content type
51
+ Retrieve list (retrieved by Title) content type
46
52
 
47
53
  ```sh
48
54
  m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
49
55
  ```
56
+
57
+ Retrieve list (retrieved by ID) content type
58
+
59
+ ```sh
60
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
61
+ ```
62
+
63
+ Retrieve list (retrieved by URL) content type
64
+
65
+ ```sh
66
+ m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
67
+ ```
@@ -26,10 +26,10 @@ Specify either `listTitle`, `listId` or `listUrl`.
26
26
  Specify either `listTitle`, `listId` or `listUrl`.
27
27
 
28
28
  `-n, --name [name]`
29
- The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
29
+ : The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-i, --id [id]`
32
- The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
32
+ : The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
33
33
 
34
34
  `-s, --scope [scope]`
35
35
  : The scope of which to retrieve the Event Receivers.
@@ -23,10 +23,10 @@ m365 spo eventreceiver remove [options]
23
23
  : The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
24
24
 
25
25
  `-n, --name [name]`
26
- The name. Specify either `name` or `id` but not both.
26
+ : The name. Specify either `name` or `id` but not both.
27
27
 
28
28
  `-i, --id [id]`
29
- The id. Specify either `name` or `id` but not both.
29
+ : The id. Specify either `name` or `id` but not both.
30
30
 
31
31
  `-s, --scope [scope]`
32
32
  : The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
@@ -14,7 +14,13 @@ m365 spo field add [options]
14
14
  : Absolute URL of the site where the field should be created
15
15
 
16
16
  `-l, --listTitle [listTitle]`
17
- : Title of the list where the field should be created (if it should be created as a list column)
17
+ : Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
+
19
+ `--listId [listId]`
20
+ : ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
18
24
 
19
25
  `-x, --xml <xml>`
20
26
  : CAML field definition
@@ -36,7 +42,7 @@ Create a date time site column
36
42
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
37
43
  ```
38
44
 
39
- Create a URL list column
45
+ Create a URL list column to a list retrieved by Title
40
46
 
41
47
  ```sh
42
48
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
48
54
  m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
49
55
  ```
50
56
 
57
+ Create a URL list column to a list retrieved by ID
58
+
59
+ ```sh
60
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
61
+ ```
62
+
63
+ Create a date time list column to a list retrieved by URL
64
+
65
+ ```sh
66
+ m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
67
+ ```
68
+
51
69
  ## More information
52
70
 
53
71
  - AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)