@pnp/cli-microsoft365 6.0.0-beta.845d3c1 → 6.0.0-beta.9dde439

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 (134) hide show
  1. package/dist/Command.js +16 -2
  2. package/dist/m365/aad/commands/app/app-list.js +38 -0
  3. package/dist/m365/aad/commands/user/user-guest-add.js +103 -0
  4. package/dist/m365/aad/commands.js +2 -0
  5. package/dist/m365/commands/status.js +6 -1
  6. package/dist/m365/outlook/commands/message/message-get.js +97 -0
  7. package/dist/m365/outlook/commands.js +1 -0
  8. package/dist/m365/pp/commands/card/card-remove.js +130 -0
  9. package/dist/m365/pp/commands.js +1 -0
  10. package/dist/m365/spfx/commands/project/project-doctor.js +4 -1
  11. package/dist/m365/spfx/commands/project/project-externalize.js +4 -1
  12. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010001_YORC_version.js +2 -1
  13. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010002_YORC_isCreatingSolution.js +2 -1
  14. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010003_YORC_packageManager.js +2 -1
  15. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010004_YORC_componentType.js +2 -1
  16. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010005_YORC_environment.js +2 -1
  17. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010006_YORC_framework.js +3 -2
  18. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010007_YORC_isDomainIsolated.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010008_YORC_nodeVersion.js +2 -1
  20. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010009_YORC_sdkVersions_microsoft_graph_client.js +56 -0
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN010010_YORC_sdkVersions_teams_js.js +56 -0
  22. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.16.0-beta.1.js → upgrade-1.16.0-beta.2.js} +44 -28
  23. package/dist/m365/spfx/commands/project/project-upgrade.js +5 -2
  24. package/dist/m365/spfx/commands/spfx-doctor.js +3 -3
  25. package/dist/m365/spo/commands/field/field-add.js +26 -1
  26. package/dist/m365/spo/commands/field/field-set.js +23 -13
  27. package/dist/m365/spo/commands/folder/folder-list.js +35 -12
  28. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +11 -1
  29. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +12 -1
  30. package/dist/m365/spo/commands/list/list-roleassignment-add.js +1 -1
  31. package/dist/m365/spo/commands/list/list-view-field-add.js +19 -5
  32. package/dist/m365/spo/commands/list/list-view-field-remove.js +18 -4
  33. package/dist/m365/spo/commands/list/list-view-field-set.js +18 -4
  34. package/dist/m365/spo/commands/list/list-view-list.js +14 -10
  35. package/dist/m365/spo/commands/list/list-view-remove.js +17 -8
  36. package/dist/m365/spo/commands/list/list-view-set.js +19 -7
  37. package/dist/m365/spo/commands/list/list-webhook-get.js +2 -3
  38. package/dist/m365/spo/commands/list/list-webhook-set.js +11 -12
  39. package/dist/m365/spo/commands/listitem/listitem-add.js +24 -14
  40. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +18 -8
  41. package/dist/m365/spo/commands/listitem/listitem-get.js +18 -8
  42. package/dist/m365/spo/commands/listitem/listitem-isrecord.js +20 -10
  43. package/dist/m365/spo/commands/listitem/listitem-list.js +21 -11
  44. package/dist/m365/spo/commands/listitem/listitem-record-declare.js +19 -12
  45. package/dist/m365/spo/commands/listitem/listitem-record-undeclare.js +24 -21
  46. package/dist/m365/spo/commands/listitem/listitem-remove.js +19 -11
  47. package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +239 -0
  48. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +13 -5
  49. package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +13 -5
  50. package/dist/m365/spo/commands/listitem/listitem-set.js +52 -44
  51. package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +15 -2
  52. package/dist/m365/spo/commands/{hubsite/hubsite-theme-sync.js → site/site-hubsite-theme-sync.js} +11 -11
  53. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +100 -0
  54. package/dist/m365/spo/commands.js +4 -2
  55. package/dist/m365/teams/commands/channel/channel-get.js +2 -2
  56. package/dist/m365/teams/commands/channel/channel-remove.js +56 -39
  57. package/dist/m365/teams/commands/channel/channel-set.js +57 -19
  58. package/dist/m365/todo/commands/list/list-get.js +89 -0
  59. package/dist/m365/todo/commands/task/task-get.js +108 -0
  60. package/dist/m365/todo/commands.js +2 -0
  61. package/dist/utils/md.js +8 -1
  62. package/docs/docs/cmd/aad/app/app-list.md +149 -0
  63. package/docs/docs/cmd/aad/user/user-guest-add.md +107 -0
  64. package/docs/docs/cmd/adaptivecard/adaptivecard-send.md +3 -0
  65. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md +4 -11
  66. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md +4 -10
  67. package/docs/docs/cmd/outlook/message/message-get.md +48 -0
  68. package/docs/docs/cmd/planner/bucket/bucket-add.md +29 -0
  69. package/docs/docs/cmd/planner/bucket/bucket-get.md +29 -0
  70. package/docs/docs/cmd/planner/bucket/bucket-list.md +30 -0
  71. package/docs/docs/cmd/planner/bucket/bucket-remove.md +4 -0
  72. package/docs/docs/cmd/planner/bucket/bucket-set.md +4 -0
  73. package/docs/docs/cmd/planner/plan/plan-add.md +123 -0
  74. package/docs/docs/cmd/planner/plan/plan-get.md +75 -0
  75. package/docs/docs/cmd/planner/plan/plan-list.md +45 -0
  76. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  77. package/docs/docs/cmd/pp/card/card-remove.md +82 -0
  78. package/docs/docs/cmd/spfx/project/project-rename.md +1 -14
  79. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  80. package/docs/docs/cmd/spo/customaction/customaction-add.md +3 -0
  81. package/docs/docs/cmd/spo/customaction/customaction-set.md +3 -2
  82. package/docs/docs/cmd/spo/field/field-add.md +20 -2
  83. package/docs/docs/cmd/spo/field/field-set.md +15 -3
  84. package/docs/docs/cmd/spo/folder/folder-list.md +45 -0
  85. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +6 -0
  86. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +6 -0
  87. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +2 -2
  88. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +2 -2
  89. package/docs/docs/cmd/spo/list/list-view-field-add.md +14 -4
  90. package/docs/docs/cmd/spo/list/list-view-field-remove.md +11 -2
  91. package/docs/docs/cmd/spo/list/list-view-field-set.md +18 -2
  92. package/docs/docs/cmd/spo/list/list-view-list.md +16 -7
  93. package/docs/docs/cmd/spo/list/list-view-remove.md +12 -3
  94. package/docs/docs/cmd/spo/list/list-view-set.md +20 -6
  95. package/docs/docs/cmd/spo/list/list-webhook-get.md +1 -1
  96. package/docs/docs/cmd/spo/list/list-webhook-set.md +11 -4
  97. package/docs/docs/cmd/spo/listitem/listitem-add.md +11 -2
  98. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +11 -2
  99. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  100. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +12 -2
  101. package/docs/docs/cmd/spo/listitem/listitem-list.md +10 -1
  102. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +7 -4
  103. package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.md +11 -2
  104. package/docs/docs/cmd/spo/listitem/listitem-remove.md +11 -2
  105. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.md +81 -0
  106. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +7 -4
  107. package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +8 -5
  108. package/docs/docs/cmd/spo/listitem/listitem-set.md +7 -4
  109. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +5 -10
  110. package/docs/docs/cmd/spo/page/page-control-set.md +2 -1
  111. package/docs/docs/cmd/spo/{hubsite/hubsite-theme-sync.md → site/site-hubsite-theme-sync.md} +5 -5
  112. package/docs/docs/cmd/spo/term/term-add.md +5 -0
  113. package/docs/docs/cmd/spo/term/term-set-add.md +6 -1
  114. package/docs/docs/cmd/spo/web/web-roleinheritance-break.md +44 -0
  115. package/docs/docs/cmd/teams/channel/channel-get.md +7 -7
  116. package/docs/docs/cmd/teams/channel/channel-remove.md +12 -9
  117. package/docs/docs/cmd/teams/channel/channel-set.md +13 -6
  118. package/docs/docs/cmd/tenant/id/id-get.md +20 -0
  119. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +35 -0
  120. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +49 -0
  121. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +32 -0
  122. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +30 -0
  123. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +36 -0
  124. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +41 -0
  125. package/docs/docs/cmd/tenant/security/security-alerts-list.md +105 -0
  126. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +87 -0
  127. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +91 -0
  128. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +62 -0
  129. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +51 -0
  130. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +64 -0
  131. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +52 -0
  132. package/docs/docs/cmd/todo/list/list-get.md +61 -0
  133. package/docs/docs/cmd/todo/task/task-get.md +75 -0
  134. package/package.json +10 -6
@@ -43,3 +43,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
43
43
  ```sh
44
44
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
45
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.
@@ -0,0 +1,82 @@
1
+ # pp card remove
2
+
3
+ Removes the specified Microsoft Power Platform card in the specified Power Platform environment
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 pp card remove [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
+ `--asAdmin`
23
+ : Run the command as admin for environments you do not have explicitly assigned permissions to.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the name parameter
33
+
34
+ ```sh
35
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name"
36
+ ```
37
+
38
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the name parameter without confirmation
39
+
40
+ ```sh
41
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --confirm
42
+ ```
43
+
44
+ Removes the specified Microsoft Power Platform card owned by another user based on the name parameter
45
+
46
+ ```sh
47
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --asAdmin
48
+ ```
49
+
50
+ Removes the specified Microsoft Power Platform card owned by another user based on the name parameter without confirmation
51
+
52
+ ```sh
53
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Card Name" --asAdmin --confirm
54
+ ```
55
+
56
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the id parameter
57
+
58
+ ```sh
59
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e
60
+ ```
61
+
62
+ Removes the specified Microsoft Power Platform card owned by the currently signed-in user based on the id parameter without confirmation
63
+
64
+ ```sh
65
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --confirm
66
+ ```
67
+
68
+ Removes the specified Microsoft Power Platform card owned by another user based on the id parameter
69
+
70
+ ```sh
71
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --asAdmin
72
+ ```
73
+
74
+ Removes the specified Microsoft Power Platform card owned by another user based on the id parameter without confirmation
75
+
76
+ ```sh
77
+ m365 pp card remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --asAdmin --confirm
78
+ ```
79
+
80
+ ## Response
81
+
82
+ The command won't return a response on success.
@@ -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
 
@@ -78,6 +78,9 @@ Note, how the clientSideComponentProperties option (-p) has escaped double quote
78
78
 
79
79
  The `--rights` option accepts **case sensitive** values.
80
80
 
81
+ !!! warning "Escaping JSON in PowerShell"
82
+ When using the `--clientSideComponentProperties` 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.
83
+
81
84
  ## Examples
82
85
 
83
86
  Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_
@@ -77,12 +77,13 @@ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for
77
77
  m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
78
78
  ```
79
79
 
80
- Note, how the `clientSideComponentProperties` option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
81
-
82
80
  The `--rights` option accepts **case-sensitive** values.
83
81
 
84
82
  Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
85
83
 
84
+ !!! warning "Escaping JSON in PowerShell"
85
+ When using the `--clientSideComponentProperties` 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.
86
+
86
87
  ## Examples
87
88
 
88
89
  Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_
@@ -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)
@@ -14,10 +14,13 @@ m365 spo field set [options]
14
14
  : Absolute URL of the site where the field is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
21
24
 
22
25
  `-i, --id [id]`
23
26
  : ID of the field to update. Specify `id` or `title` but not both
@@ -34,6 +37,9 @@ m365 spo field set [options]
34
37
 
35
38
  Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
36
39
 
40
+ !!! warning "Escaping JSON in PowerShell"
41
+ When updating column formatting for a field with the `--CustomFormatter` 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.
42
+
37
43
  ## Examples
38
44
 
39
45
  Update the title of the site column specified by its internal name and push changes to existing lists
@@ -48,8 +54,14 @@ Update the title of the list column specified by its ID
48
54
  m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
49
55
  ```
50
56
 
57
+ Update the description of a column specified by the ID on a list retrieved by the URL
58
+
59
+ ```sh
60
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
61
+ ```
62
+
51
63
  Update column formatting of the specified list column
52
64
 
53
65
  ```sh
54
- m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
66
+ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
55
67
  ```
@@ -16,6 +16,9 @@ m365 spo folder list [options]
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
17
  : Site-relative URL of the parent folder
18
18
 
19
+ `-r, --recursive`
20
+ : Set to retrieve nested folders
21
+
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Examples
@@ -25,3 +28,45 @@ Gets list of folders under a parent folder with site-relative url _/Shared Docum
25
28
  ```sh
26
29
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
27
30
  ```
31
+
32
+ Gets recursive list of folders under a specific folder on a specific site
33
+
34
+ ```sh
35
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
36
+ ```
37
+
38
+ ## Response
39
+
40
+ === "JSON"
41
+
42
+ ```json
43
+ [
44
+ {
45
+ "Exists": true,
46
+ "IsWOPIEnabled": false,
47
+ "ItemCount": 9,
48
+ "Name": "Folder A",
49
+ "ProgID": null,
50
+ "ServerRelativeUrl": "/Shared Documents/Folder A",
51
+ "TimeCreated": "2022-04-26T12:30:56Z",
52
+ "TimeLastModified": "2022-04-26T12:50:14Z",
53
+ "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
54
+ "WelcomePage": ""
55
+ }
56
+ ]
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```text
62
+ Name ServerRelativeUrl
63
+ ------- -------------------------
64
+ Folder A /Shared Documents/Folder A
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ Name,ServerRelativeUrl
71
+ Folder A,/Shared Documents/Folder A
72
+ ```
@@ -37,3 +37,9 @@ Break the inheritance of a folder with a specified server-relative URL. It will
37
37
  ```sh
38
38
  m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --clearExistingPermissions --confirm
39
39
  ```
40
+
41
+ Break the inheritance of the specified root folder for the library with a specified server-relative URL. It will clear the existing permissions of the root folder. It will **not** prompt for confirmation before breaking the inheritance.
42
+
43
+ ```sh
44
+ m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --confirm
45
+ ```
@@ -34,3 +34,9 @@ Reset inheritance of folder with server-relative url _/sites/project-x/Shared Do
34
34
  ```sh
35
35
  m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
36
36
  ```
37
+
38
+ Reset inheritance of the specified root folder for the library with the server-relative url _/sites/project-x/Shared Documents located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
39
+
40
+ ```sh
41
+ m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
42
+ ```
@@ -17,8 +17,8 @@ m365 spo hubsite register [options]
17
17
 
18
18
  ## Remarks
19
19
 
20
- !!! attention
21
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
20
+ !!! important
21
+ To use this command you must be a Global or SharePoint administrator.
22
22
 
23
23
  If the specified site collection is already registered as a hub site, you will get a `This site is already a HubSite.` error.
24
24
 
@@ -20,8 +20,8 @@ m365 spo hubsite unregister [options]
20
20
 
21
21
  ## Remarks
22
22
 
23
- !!! attention
24
- This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
23
+ !!! important
24
+ To use this command you must be a Global or SharePoint administrator.
25
25
 
26
26
  If the specified site collection is not registered as a hub site, you will get a `hubSiteId` error.
27
27
 
@@ -14,10 +14,13 @@ m365 spo list view field add [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -50,8 +53,15 @@ Add field with title _Custom field_ to view with title _All Documents_ of the li
50
53
  m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field'
51
54
  ```
52
55
 
53
- Add field with title _Custom field_ at the position _0_ to view with title _All Documents_ of the list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
56
+ Add field with title _Custom field_ at the position _0_ to view with title _My Events_ of the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'My Events' --title 'Custom field' --fieldPosition 0
60
+ ```
61
+
62
+ Add field with title _Custom field_ to view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
63
 
55
64
  ```sh
56
- m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 0
65
+ m365 spo list view field add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field'
57
66
  ```
67
+
@@ -14,10 +14,13 @@ m365 spo list view field remove [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -46,3 +49,9 @@ Remove field with title _Custom field_ from view with title _Custom view_ from t
46
49
  ```sh
47
50
  m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --title 'Custom field' --listTitle Documents --viewTitle 'Custom view'
48
51
  ```
52
+
53
+ Remove field with title _Custom field_ from view with title _Custom view_ from the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
54
+
55
+ ```sh
56
+ m365 spo list view field remove --webUrl https://contoso.sharepoint.com/sites/project-x --fieldTitle 'Custom field' --listUrl '/sites/project-x/lists/Events' --viewTitle 'Custom view'
57
+ ```
@@ -14,10 +14,13 @@ m365 spo list view field set [options]
14
14
  : URL of the site where the list is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the view is located. Specify `listTitle` or `listId` but not both
17
+ : ID of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the view is located. Specify `listTitle` or `listId` but not both
20
+ : Title of the list where the view is located. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--viewId [viewId]`
23
26
  : ID of the view to update. Specify `viewTitle` or `viewId` but not both
@@ -49,3 +52,16 @@ Move field with title _Custom field_ to position _1_ in view with title _All Doc
49
52
  ```sh
50
53
  m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --viewTitle 'All Documents' --title 'Custom field' --position 1
51
54
  ```
55
+
56
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
60
+ ```
61
+
62
+ Move field with title _Custom field_ to position _1_ in view with title _All Documents_ of the list with site-relative URL _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
63
+
64
+ ```sh
65
+ m365 spo list view field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/Shared Documents' --viewTitle 'All Documents' --fieldTitle 'Custom field' --fieldPosition 1
66
+ ```
67
+
@@ -10,27 +10,36 @@ m365 spo list view list [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-u, --webUrl <webUrl>`
13
+ `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located
15
15
 
16
- `-i, --listId [listId]`
17
- : ID of the list for which to list configured views. Specify `listId` or `listTitle` but not both
16
+ `-i, --listId [listId]`
17
+ : ID of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
- `-t, --listTitle [listTitle]`
20
- : Title of the list for which to list configured views. Specify `listId` or `listTitle` but not both
19
+ `-t, --listTitle [listTitle]`
20
+ : Title of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  --8<-- "docs/cmd/_global.md"
23
26
 
24
27
  ## Examples
25
28
 
26
- List all views for a list with title *Documents* located in site *https://contoso.sharepoint.com/sites/project-x*
29
+ List all views for a list by title
27
30
 
28
31
  ```sh
29
32
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents
30
33
  ```
31
34
 
32
- List all views for a list with ID *0cd891ef-afce-4e55-b836-fce03286cccf* located in site *https://contoso.sharepoint.com/sites/project-x*
35
+ List all views for a list by ID
33
36
 
34
37
  ```sh
35
38
  m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
36
39
  ```
40
+
41
+ List all views for a list by URL
42
+
43
+ ```sh
44
+ m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events'
45
+ ```
@@ -14,10 +14,13 @@ m365 spo list view remove [options]
14
14
  : URL of the site where the list to remove the view from is located
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
17
+ : ID of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list from which the view should be removed. Specify either `listId` or `listTitle` but not both
20
+ : Title of the list from which the view should be removed. Specify either `listId`, `listTitle`, or `listUrl`.
21
+
22
+ `--listUrl [listUrl]`
23
+ : Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.
21
24
 
22
25
  `--id [id]`
23
26
  : ID of the view to remove. Specify either `id` or `title` but not both
@@ -32,7 +35,7 @@ m365 spo list view remove [options]
32
35
 
33
36
  ## Examples
34
37
 
35
- Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from the list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
38
+ Remove view from the list by ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
39
 
37
40
  ```sh
38
41
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id cc27a922-8224-4296-90a5-ebbc54da2e81
@@ -50,6 +53,12 @@ Remove view with title _MyView_ from a list with title _Documents_ located in si
50
53
  m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents --title MyView
51
54
  ```
52
55
 
56
+ Remove view with title _MyView_ from a list with url _/sites/project-x/lists/Events_ located in site _https://contoso.sharepoint.com/sites/project-x_
57
+
58
+ ```sh
59
+ m365 spo list view remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events' --viewTitle MyView
60
+ ```
61
+
53
62
  Remove view with ID _cc27a922-8224-4296-90a5-ebbc54da2e81_ from a list with title _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_ without being asked for confirmation
54
63
 
55
64
  ```sh