@pnp/cli-microsoft365 6.1.0-beta.3e0114a → 6.1.0-beta.539ef23

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 (93) hide show
  1. package/dist/m365/aad/commands/group/group-get.js +79 -0
  2. package/dist/m365/aad/commands/user/user-set.js +84 -11
  3. package/dist/m365/aad/commands.js +1 -0
  4. package/dist/m365/base/ContextCommand.js +33 -0
  5. package/dist/m365/context/commands/context-init.js +28 -0
  6. package/dist/m365/context/commands/context-remove.js +103 -0
  7. package/dist/m365/context/commands.js +8 -0
  8. package/dist/m365/pp/commands/dataverse/dataverse-table-row-remove.js +133 -0
  9. package/dist/m365/pp/commands/environment/environment-get.js +5 -13
  10. package/dist/m365/pp/commands.js +1 -0
  11. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +142 -0
  12. package/dist/m365/purview/commands.js +2 -1
  13. package/dist/m365/search/commands/externalconnection/externalconnection-schema-add.js +86 -0
  14. package/dist/m365/search/commands.js +2 -1
  15. package/dist/m365/spo/commands/group/group-member-add.js +68 -30
  16. package/dist/m365/spo/commands/group/group-member-remove.js +50 -7
  17. package/dist/m365/spo/commands/list/{list-label-set.js → list-retentionlabel-ensure.js} +25 -15
  18. package/dist/m365/spo/commands/list/{list-label-get.js → list-retentionlabel-get.js} +19 -15
  19. package/dist/m365/spo/commands/listitem/listitem-remove.js +1 -1
  20. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +143 -0
  21. package/dist/m365/spo/commands/page/page-add.js +60 -63
  22. package/dist/m365/spo/commands/page/page-set.js +59 -70
  23. package/dist/m365/spo/commands/site/site-appcatalog-list.js +43 -0
  24. package/dist/m365/spo/commands/web/web-retentionlabel-list.js +63 -0
  25. package/dist/m365/spo/commands.js +5 -0
  26. package/dist/request.js +2 -1
  27. package/dist/utils/pid.js +31 -15
  28. package/docs/docs/cmd/aad/group/group-get.md +127 -0
  29. package/docs/docs/cmd/aad/user/user-set.md +31 -3
  30. package/docs/docs/cmd/context/context-init.md +25 -0
  31. package/docs/docs/cmd/context/context-remove.md +34 -0
  32. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.md +61 -0
  33. package/docs/docs/cmd/pp/environment/environment-get.md +9 -3
  34. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +63 -0
  35. package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.md +31 -0
  36. package/docs/docs/cmd/spo/group/group-member-add.md +58 -6
  37. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -8
  38. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +65 -0
  39. package/docs/docs/cmd/spo/list/{list-label-get.md → list-retentionlabel-get.md} +17 -11
  40. package/docs/docs/cmd/spo/listitem/listitem-remove.md +6 -6
  41. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.md +55 -0
  42. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +9 -5
  43. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +42 -0
  44. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +25 -3
  45. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +22 -0
  46. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +6 -2
  47. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +5 -1
  48. package/docs/docs/cmd/spo/page/page-add.md +13 -9
  49. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +6 -2
  50. package/docs/docs/cmd/spo/page/page-column-get.md +68 -5
  51. package/docs/docs/cmd/spo/page/page-column-list.md +36 -4
  52. package/docs/docs/cmd/spo/page/page-control-get.md +70 -3
  53. package/docs/docs/cmd/spo/page/page-control-list.md +69 -3
  54. package/docs/docs/cmd/spo/page/page-control-set.md +11 -7
  55. package/docs/docs/cmd/spo/page/page-copy.md +65 -4
  56. package/docs/docs/cmd/spo/page/page-get.md +100 -4
  57. package/docs/docs/cmd/spo/page/page-header-set.md +17 -13
  58. package/docs/docs/cmd/spo/page/page-list.md +122 -1
  59. package/docs/docs/cmd/spo/page/page-remove.md +9 -5
  60. package/docs/docs/cmd/spo/page/page-section-add.md +10 -6
  61. package/docs/docs/cmd/spo/page/page-section-get.md +36 -4
  62. package/docs/docs/cmd/spo/page/page-section-list.md +38 -3
  63. package/docs/docs/cmd/spo/page/page-set.md +10 -10
  64. package/docs/docs/cmd/spo/page/page-template-list.md +58 -1
  65. package/docs/docs/cmd/spo/page/page-text-add.md +9 -5
  66. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +28 -8
  67. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +35 -7
  68. package/docs/docs/cmd/spo/propertybag/propertybag-remove.md +13 -9
  69. package/docs/docs/cmd/spo/propertybag/propertybag-set.md +13 -5
  70. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +34 -2
  71. package/docs/docs/cmd/spo/report/report-activitypages.md +31 -2
  72. package/docs/docs/cmd/spo/report/report-activityusercounts.md +35 -2
  73. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +40 -3
  74. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +43 -3
  75. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +33 -2
  76. package/docs/docs/cmd/spo/report/report-siteusagepages.md +32 -2
  77. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +33 -2
  78. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +32 -2
  79. package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md +10 -6
  80. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +80 -2
  81. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +76 -2
  82. package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.md +9 -5
  83. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +39 -2
  84. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +32 -0
  85. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md +6 -2
  86. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +14 -74
  87. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md +6 -2
  88. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +30 -0
  89. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +36 -2
  90. package/docs/docs/cmd/spo/site/site-appcatalog-list.md +55 -0
  91. package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +74 -0
  92. package/package.json +1 -1
  93. package/docs/docs/cmd/spo/list/list-label-set.md +0 -55
@@ -11,7 +11,7 @@ m365 spo page list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site from which to retrieve available pages
14
+ : URL of the site from which to retrieve available pages.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -22,3 +22,124 @@ List all modern pages in the specific site
22
22
  ```sh
23
23
  m365 spo page list --webUrl https://contoso.sharepoint.com/sites/team-a
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ [
32
+ {
33
+ "CheckInComment": "",
34
+ "CheckOutType": 2,
35
+ "ContentTag": "{5A5E4B79-C3F7-479A-B9E5-9A462696C92A},1,1",
36
+ "CustomizedPageStatus": 0,
37
+ "ETag": "\"{5A5E4B79-C3F7-479A-B9E5-9A462696C92A},1\"",
38
+ "Exists": true,
39
+ "IrmEnabled": false,
40
+ "Length": 2666,
41
+ "Level": 1,
42
+ "LinkingUri": null,
43
+ "LinkingUrl": "",
44
+ "MajorVersion": 1,
45
+ "MinorVersion": 0,
46
+ "Name": "Home.aspx",
47
+ "ServerRelativeUrl": "/sites/SPDemo/SitePages/Home.aspx",
48
+ "TimeCreated": "2020-09-06T09:18:59Z",
49
+ "TimeLastModified": "2020-09-06T09:18:59Z",
50
+ "Title": "Home",
51
+ "UIVersion": 512,
52
+ "UIVersionLabel": "1.0",
53
+ "UniqueId": "5a5e4b79-c3f7-479a-b9e5-9a462696c92a",
54
+ "ListItemAllFields": {
55
+ "FileSystemObjectType": 0,
56
+ "Id": 10,
57
+ "ServerRedirectedEmbedUri": null,
58
+ "ServerRedirectedEmbedUrl": "",
59
+ "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
60
+ "OData__ModerationComments": null,
61
+ "ComplianceAssetId": null,
62
+ "WikiField": null,
63
+ "Title": "Home",
64
+ "ClientSideApplicationId": "b6917cb1-93a0-4b97-a84d-7cf49975d4ec",
65
+ "CanvasContent1": "<div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;3,&quot;webPartId&quot;&#58;&quot;e89b5ad5-9ab5-4730-a66b-e1f68994598c&quot;,&quot;id&quot;&#58;&quot;8bba86eb-3174-4917-b2b8-417af1102351&quot;&#125;\"><div data-sp-webpart=\"\" data-sp-webpartdataversion=\"1.0\" data-sp-webpartdata=\"&#123;&quot;id&quot;&#58;&quot;e89b5ad5-9ab5-4730-a66b-e1f68994598c&quot;,&quot;instanceId&quot;&#58;&quot;8bba86eb-3174-4917-b2b8-417af1102351&quot;,&quot;title&quot;&#58;&quot;ReactProvisionAssets&quot;,&quot;description&quot;&#58;&quot;ReactProvisionAssets description&quot;,&quot;dataVersion&quot;&#58;&quot;1.0&quot;,&quot;properties&quot;&#58;&#123;&quot;description&quot;&#58;&quot;ReactProvisionAssets&quot;&#125;&#125;\"><div data-sp-componentid=\"\">e89b5ad5-9ab5-4730-a66b-e1f68994598c</div><div data-sp-htmlproperties=\"\"></div></div></div></div>",
66
+ "BannerImageUrl": {
67
+ "Description": "/_layouts/15/images/sitepagethumbnail.png",
68
+ "Url": "https://contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png"
69
+ },
70
+ "Description": null,
71
+ "PromotedState": 0,
72
+ "FirstPublishedDate": null,
73
+ "LayoutWebpartsContent": null,
74
+ "OData__AuthorBylineId": null,
75
+ "_AuthorBylineStringId": null,
76
+ "OData__TopicHeader": null,
77
+ "OData__SPSitePageFlags": null,
78
+ "OData__OriginalSourceUrl": null,
79
+ "OData__OriginalSourceSiteId": null,
80
+ "OData__OriginalSourceWebId": null,
81
+ "OData__OriginalSourceListId": null,
82
+ "OData__OriginalSourceItemId": null,
83
+ "OData__SPCallToAction": null,
84
+ "OData__ModerationStatus": 0,
85
+ "ID": 10,
86
+ "Created": "2020-09-06T02:18:55-07:00",
87
+ "AuthorId": 1073741823,
88
+ "Modified": "2020-09-06T02:18:55-07:00",
89
+ "EditorId": 1073741823,
90
+ "OData__CopySource": null,
91
+ "CheckoutUserId": null,
92
+ "OData__UIVersionString": "1.0",
93
+ "GUID": "3762c79f-a768-40f0-bc7b-4d2ab03f22e0"
94
+ },
95
+ "AbsoluteUrl": "https://contoso.sharepoint.com/sites/SPDemo/SitePages/Home.aspx",
96
+ "AuthorByline": null,
97
+ "BannerImageUrl": "https://contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png",
98
+ "BannerThumbnailUrl": "https://media.akamai.odsp.cdn.office.net/contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png",
99
+ "CallToAction": "",
100
+ "Categories": null,
101
+ "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
102
+ "Description": null,
103
+ "DoesUserHaveEditPermission": true,
104
+ "FileName": "Home.aspx",
105
+ "FirstPublished": "0001-01-01T08:00:00Z",
106
+ "Id": 10,
107
+ "IsPageCheckedOutToCurrentUser": false,
108
+ "IsWebWelcomePage": false,
109
+ "Modified": "2020-09-06T09:18:59Z",
110
+ "PageLayoutType": "Article",
111
+ "Path": {
112
+ "DecodedUrl": "SitePages/Home.aspx"
113
+ },
114
+ "PromotedState": 0,
115
+ "TopicHeader": null,
116
+ "Url": "SitePages/Home.aspx",
117
+ "Version": "1.0",
118
+ "VersionInfo": {
119
+ "LastVersionCreated": "0001-01-01T00:00:00-08:00",
120
+ "LastVersionCreatedBy": ""
121
+ },
122
+ "AlternativeUrlMap": "{\"MediaTAThumbnailPathUrl\":\"https://southindia1-mediap.svc.ms/transform/thumbnail?provider=spo&inputFormat={.fileType}&cs=UEFHRVN8U1BP&docid={.spHost}/_api/v2.0/sharePoint:{.resourceUrl}:/driveItem&w={.widthValue}&oauth_token=bearer%20{.oauthToken}\",\"MediaTAThumbnailHostUrl\":\"https://southindia1-mediap.svc.ms\",\"AFDCDNEnabled\":\"ClientNotOnEdge\",\"CurrentSiteCDNPolicy\":\"True\",\"PublicCDNEnabled\":\"True\",\"PrivateCDNEnabled\":\"True\"}",
123
+ "CanvasContent1": "[{\"controlType\":3,\"webPartId\":\"e89b5ad5-9ab5-4730-a66b-e1f68994598c\",\"id\":\"8bba86eb-3174-4917-b2b8-417af1102351\",\"webPartData\":{\"id\":\"e89b5ad5-9ab5-4730-a66b-e1f68994598c\",\"instanceId\":\"8bba86eb-3174-4917-b2b8-417af1102351\",\"title\":\"ReactProvisionAssets\",\"description\":\"ReactProvisionAssets description\",\"dataVersion\":\"1.0\",\"properties\":{\"description\":\"ReactProvisionAssets\"},\"serverProcessedContent\":{\"htmlStrings\":{},\"searchablePlainTexts\":{},\"imageSources\":{},\"links\":{}}}}]",
124
+ "CoAuthState": null,
125
+ "Language": "en-us",
126
+ "LayoutWebpartsContent": null,
127
+ "SitePageFlags": ""
128
+ }
129
+ ]
130
+ ```
131
+
132
+ === "Text"
133
+
134
+ ```text
135
+ Name Title
136
+ ----------- -------
137
+ Home.aspx Home
138
+ ```
139
+
140
+ === "CSV"
141
+
142
+ ```csv
143
+ Name,Title
144
+ Home.aspx,Home
145
+ ```
@@ -11,13 +11,13 @@ m365 spo page remove [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --name <name>`
14
- : Name of the page to remove
14
+ : Name of the page to remove.
15
15
 
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site from which the page should be removed
17
+ : URL of the site from which the page should be removed.
18
18
 
19
19
  `--confirm`
20
- : Do not prompt for confirmation before removing the page
20
+ : Do not prompt for confirmation before removing the page.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -29,14 +29,18 @@ If you set the `--confirm` flag, you will not be prompted for confirmation befor
29
29
 
30
30
  ## Examples
31
31
 
32
- Remove a modern page.
32
+ Remove a modern page
33
33
 
34
34
  ```sh
35
35
  m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team
36
36
  ```
37
37
 
38
- Remove a modern page without a confirmation prompt.
38
+ Remove a modern page without a confirmation prompt
39
39
 
40
40
  ```sh
41
41
  m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --confirm
42
42
  ```
43
+
44
+ ## Response
45
+
46
+ The command won't return a response on success.
@@ -11,16 +11,16 @@ m365 spo page section add [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --pageName <pageName>`
14
- : Name of the page to add section to
14
+ : Name of the page to add section to.
15
15
 
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the page to retrieve is located
17
+ : URL of the site where the page to retrieve is located.
18
18
 
19
19
  `-t, --sectionTemplate <sectionTemplate>`
20
- : Type of section to add. Allowed values `OneColumn,OneColumnFullWidth,TwoColumn,ThreeColumn,TwoColumnLeft,TwoColumnRight`
20
+ : Type of section to add. Allowed values `OneColumn`, `OneColumnFullWidth`, `TwoColumn`, `ThreeColumn`, `TwoColumnLeft`, `TwoColumnRight`.
21
21
 
22
22
  `--order [order]`
23
- : Order of the section to add
23
+ : Order of the section to add.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -30,8 +30,12 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
30
30
 
31
31
  ## Examples
32
32
 
33
- Add section to the modern page named _home.aspx_
33
+ Add section to the modern page
34
34
 
35
35
  ```sh
36
- m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate OneColumn --order 1
36
+ m365 spo page section add --pageName home.aspx --webUrl https://contoso.sharepoint.com/sites/newsletter --sectionTemplate OneColumn --order 1
37
37
  ```
38
+
39
+ ## Response
40
+
41
+ The command won't return a response on success.
@@ -11,13 +11,13 @@ m365 spo page section get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the page to retrieve is located
14
+ : URL of the site where the page to retrieve is located.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page to get section information of
17
+ : Name of the page to get section information of.
18
18
 
19
19
  `-s, --section <sectionId>`
20
- : ID of the section for which to retrieve information
20
+ : ID of the section for which to retrieve information.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -27,8 +27,40 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
27
27
 
28
28
  ## Examples
29
29
 
30
- Get information about the specified section of the modern page named _home.aspx_
30
+ Get information about the specified section of the modern page
31
31
 
32
32
  ```sh
33
33
  m365 spo page section get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1
34
34
  ```
35
+
36
+ ## Response
37
+
38
+ === "JSON"
39
+
40
+ ```json
41
+ {
42
+ "order": 1,
43
+ "columns": [
44
+ {
45
+ "factor": 12,
46
+ "order": 1,
47
+ "dataVersion": "1.0",
48
+ "jsonData": "&#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;12,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;"
49
+ }
50
+ ]
51
+ }
52
+ ```
53
+
54
+ === "Text"
55
+
56
+ ```text
57
+ columns: [{"factor":12,"order":1}]
58
+ order : 1
59
+ ```
60
+
61
+ === "CSV"
62
+
63
+ ```csv
64
+ order,columns
65
+ 1,"[{""factor"":12,""order"":1}]"
66
+ ```
@@ -11,10 +11,10 @@ m365 spo page section list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the page to retrieve is located
14
+ : URL of the site where the page to retrieve is located.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page to list sections of
17
+ : Name of the page to list sections of.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -24,8 +24,43 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
24
24
 
25
25
  ## Examples
26
26
 
27
- List sections of a modern page named _home.aspx_
27
+ List sections of a modern page
28
28
 
29
29
  ```sh
30
30
  m365 spo page section list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
31
31
  ```
32
+
33
+ ## Response
34
+
35
+ === "JSON"
36
+
37
+ ```json
38
+ [
39
+ {
40
+ "order": 1,
41
+ "columns": [
42
+ {
43
+ "factor": 12,
44
+ "order": 1,
45
+ "dataVersion": "1.0",
46
+ "jsonData": "&#123;&quot;displayMode&quot;&#58;2,&quot;position&quot;&#58;&#123;&quot;sectionFactor&quot;&#58;12,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1&#125;&#125;"
47
+ }
48
+ ]
49
+ }
50
+ ]
51
+ ```
52
+
53
+ === "Text"
54
+
55
+ ```text
56
+ order columns
57
+ ----- -------
58
+ 1 1
59
+ ```
60
+
61
+ === "CSV"
62
+
63
+ ```csv
64
+ order,columns
65
+ 1,1
66
+ ```
@@ -11,34 +11,34 @@ m365 spo page set [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --name <name>`
14
- : Name of the page to update
14
+ : Name of the page to update.
15
15
 
16
16
  `-u, --webUrl <webUrl>`
17
- : URL of the site where the page to update is located
17
+ : URL of the site where the page to update is located.
18
18
 
19
19
  `-l, --layoutType [layoutType]`
20
- : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`, `HeaderlessSearchResults`, `Spaces`, `Topic`
20
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`, `HeaderlessSearchResults`, `Spaces`, `Topic`.
21
21
 
22
22
  `-p, --promoteAs [promoteAs]`
23
- : Update the page purpose. Allowed values `HomePage`, `NewsPage`, `Template`
23
+ : Update the page purpose. Allowed values `HomePage`, `NewsPage`, `Template`.
24
24
 
25
25
  `--demoteFrom [demoteFrom]`
26
- : Update the page purpose back to a regular article. Allowed values `NewsPage`
26
+ : Update the page purpose back to a regular article. Allowed values `NewsPage`.
27
27
 
28
28
  `--commentsEnabled [commentsEnabled]`
29
- : Set to `true`, to enable comments on the page. Allowed values `true`, `false`
29
+ : Set to `true`, to enable comments on the page. Allowed values `true`, `false`.
30
30
 
31
31
  `--publish`
32
- : Set to publish the page
32
+ : Set to publish the page.
33
33
 
34
34
  `--publishMessage [publishMessage]`
35
- : Message to set when publishing the page
35
+ : Message to set when publishing the page.
36
36
 
37
37
  `--description [description]`
38
- : The description to set for the page
38
+ : The description to set for the page.
39
39
 
40
40
  `--title [title]`
41
- : The title to set for the page
41
+ : The title to set for the page.
42
42
 
43
43
  --8<-- "docs/cmd/_global.md"
44
44
 
@@ -11,7 +11,7 @@ m365 spo page template list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site from which to retrieve available pages
14
+ : URL of the site from which to retrieve available pages.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -22,3 +22,60 @@ Lists all page templates in the given site
22
22
  ```sh
23
23
  m365 spo page template list --webUrl https://contoso.sharepoint.com/sites/team-a
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ [
32
+ {
33
+ "AbsoluteUrl": "https://contoso.sharepoint.com/sites/SPDemo/SitePages/Templates/Company-Policy.aspx",
34
+ "AuthorByline": [
35
+ "i:0#.f|membership|user@contoso.com"
36
+ ],
37
+ "BannerImageUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/d22d83c8-3fb2-4168-8902-a29dc31e95b1/thumbnails/large.jpg?file=1131975775.jpg",
38
+ "BannerThumbnailUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/d22d83c8-3fb2-4168-8902-a29dc31e95b1/thumbnails/large.jpg?file=1131975775.jpg",
39
+ "CallToAction": "",
40
+ "Categories": null,
41
+ "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
42
+ "Description": "Company policy are set in place to establish the rules of conduct within an organization, outlining the responsibilities of both employees and employers. The management of company policy and procedures aim to protect the rights of workers as well as…",
43
+ "DoesUserHaveEditPermission": true,
44
+ "FileName": "Company-Policy.aspx",
45
+ "FirstPublished": "0001-01-01T08:00:00Z",
46
+ "Id": 27,
47
+ "IsPageCheckedOutToCurrentUser": false,
48
+ "IsWebWelcomePage": false,
49
+ "Modified": "2022-11-26T10:51:12Z",
50
+ "PageLayoutType": "Article",
51
+ "Path": {
52
+ "DecodedUrl": "SitePages/Templates/Company-Policy.aspx"
53
+ },
54
+ "PromotedState": 0,
55
+ "Title": "Company Policy",
56
+ "TopicHeader": null,
57
+ "UniqueId": "06509101-7e2f-4467-afd2-97bad4a53ef2",
58
+ "Url": "SitePages/Templates/Company-Policy.aspx",
59
+ "Version": "0.1",
60
+ "VersionInfo": {
61
+ "LastVersionCreated": "0001-01-01T00:00:00-08:00",
62
+ "LastVersionCreatedBy": ""
63
+ }
64
+ }
65
+ ]
66
+ ```
67
+
68
+ === "Text"
69
+
70
+ ```text
71
+ FileName Id PageLayoutType Title Url
72
+ ------------------- -- -------------- -------------- ----------------------------------------
73
+ Company-Policy.aspx 27 Article Company Policy SitePages/Templates/Company-Policy.aspx
74
+ ```
75
+
76
+ === "CSV"
77
+
78
+ ```csv
79
+ Title,FileName,Id,PageLayoutType,Url
80
+ Company Policy,Company-Policy.aspx,27,Article,SitePages/Templates/Company-Policy.aspx
81
+ ```
@@ -11,22 +11,22 @@ m365 spo page text add [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : URL of the site where the page to add the text to is located
14
+ : URL of the site where the page to add the text to is located.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page to which add the text
17
+ : Name of the page to which add the text.
18
18
 
19
19
  `-t, --text <text>`
20
20
  : Text to add to the page
21
21
 
22
22
  `--section [section]`
23
- : Number of the section to which the text should be added (1 or higher)
23
+ : Number of the section to which the text should be added (1 or higher).
24
24
 
25
25
  `--column [column]`
26
- : Number of the column in which the text should be added (1 or higher)
26
+ : Number of the column in which the text should be added (1 or higher).
27
27
 
28
28
  `--order [order]`
29
- : Order of the text in the column
29
+ : Order of the text in the column.
30
30
 
31
31
  --8<-- "docs/cmd/_global.md"
32
32
 
@@ -53,3 +53,7 @@ Add text at the beginning of the default column on a modern page
53
53
  ```sh
54
54
  m365 spo page text add --webUrl https://contoso.sharepoint.com/sites/a-team --pageName page.aspx --text 'Hello world' --order 1
55
55
  ```
56
+
57
+ ## Response
58
+
59
+ The command won't return a response on success.
@@ -11,44 +11,64 @@ m365 spo propertybag get [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site from which the property bag value should be retrieved
14
+ : The URL of the site from which the property bag value should be retrieved.
15
15
 
16
16
  `-k, --key <key>`
17
- : Key of the property for which the value should be retrieved. Case-sensitive
17
+ : Key of the property for which the value should be retrieved. Case-sensitive.
18
18
 
19
19
  `-f, --folder [folder]`
20
- : Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive
20
+ : Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
24
24
  ## Examples
25
25
 
26
- Returns the value of the _key1_ property from the property bag located in site _https://contoso.sharepoint.com/sites/test_
26
+ Returns the value of the property from the property bag located in the given site
27
27
 
28
28
  ```sh
29
29
  m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1
30
30
  ```
31
31
 
32
- Returns the value of the _key1_ property from the property bag located in site root folder _https://contoso.sharepoint.com/sites/test_
32
+ Returns the value of the property from the property bag located in root folder of the given site
33
33
 
34
34
  ```sh
35
35
  m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /
36
36
  ```
37
37
 
38
- Returns the value of the _key1_ property from the property bag located in site document library _https://contoso.sharepoint.com/sites/test_
38
+ Returns the value of the property from the property bag located in document library of the given site
39
39
 
40
40
  ```sh
41
41
  m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'
42
42
  ```
43
43
 
44
- Returns the value of the _key1_ property from the property bag located in folder in site document library _https://contoso.sharepoint.com/sites/test_
44
+ Returns the value of the property from the property bag located in folder in a document library located in the given site
45
45
 
46
46
  ```sh
47
47
  m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents/MyFolder'
48
48
  ```
49
49
 
50
- Returns the value of the _key1_ property from the property bag located in site list _https://contoso.sharepoint.com/sites/test_
50
+ Returns the value of the property from the property bag located in a list in the given site
51
51
 
52
52
  ```sh
53
53
  m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /Lists/MyList
54
54
  ```
55
+
56
+ ## Response
57
+
58
+ === "JSON"
59
+
60
+ ```json
61
+ "Approved Rejected Pending\\ Review"
62
+ ```
63
+
64
+ === "Text"
65
+
66
+ ```text
67
+ Approved Rejected Pending\\ Review
68
+ ```
69
+
70
+ === "CSV"
71
+
72
+ ```csv
73
+ Approved Rejected Pending\ Review
74
+ ```
@@ -11,41 +11,69 @@ m365 spo propertybag list [options]
11
11
  ## Options
12
12
 
13
13
  `-u, --webUrl <webUrl>`
14
- : The URL of the site from which the property bag value should be retrieved
14
+ : The URL of the site from which the property bag value should be retrieved.
15
15
 
16
16
  `-f, --folder [folder]`
17
- : Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive
17
+ : Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.
18
18
 
19
19
  --8<-- "docs/cmd/_global.md"
20
20
 
21
21
  ## Examples
22
22
 
23
- Return property bag values located in site _https://contoso.sharepoint.com/sites/test_
23
+ Return property bag values located in the given site
24
24
 
25
25
  ```sh
26
26
  m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test
27
27
  ```
28
28
 
29
- Return property bag values located in site root folder _https://contoso.sharepoint.com/sites/test_
29
+ Return property bag values located in the given site root folder
30
30
 
31
31
  ```sh
32
32
  m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /
33
33
  ```
34
34
 
35
- Return property bag values located in site document library _https://contoso.sharepoint.com/sites/test_
35
+ Return property bag values located in the given site document library
36
36
 
37
37
  ```sh
38
38
  m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents'
39
39
  ```
40
40
 
41
- Return property bag values located in folder in site document library _https://contoso.sharepoint.com/sites/test_
41
+ Return property bag values located in folder in the given site document library
42
42
 
43
43
  ```sh
44
44
  m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents/MyFolder'
45
45
  ```
46
46
 
47
- Return property bag values located in site list _https://contoso.sharepoint.com/sites/test_
47
+ Return property bag values located in the given site list
48
48
 
49
49
  ```sh
50
50
  m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /Lists/MyList
51
51
  ```
52
+
53
+ ## Response
54
+
55
+ === "JSON"
56
+
57
+ ```json
58
+ [
59
+ {
60
+ "key": "vti_approvallevels",
61
+ "value": "Approved Rejected Pending\\ Review"
62
+ }
63
+ ]
64
+ ```
65
+
66
+ === "Text"
67
+
68
+ ```text
69
+ key value
70
+ -------------------- -----------------------------------
71
+ vti_approvallevels Approved Rejected Pending\ Review
72
+ ```
73
+
74
+ === "CSV"
75
+
76
+ ```csv
77
+ key,value
78
+ vti_approvallevels,Approved Rejected Pending\ Review
79
+ ```