@pnp/cli-microsoft365 6.1.0-beta.3065124 → 6.1.0-beta.4fefcde

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 (61) hide show
  1. package/dist/m365/pp/commands/dataverse/dataverse-table-row-remove.js +133 -0
  2. package/dist/m365/pp/commands.js +1 -0
  3. package/dist/m365/spo/commands/list/{list-label-get.js → list-retentionlabel-get.js} +19 -15
  4. package/dist/m365/spo/commands/list/{list-label-set.js → list-retentionlabel-set.js} +19 -15
  5. package/dist/m365/spo/commands/page/clientsidepages.js +3 -3
  6. package/dist/m365/spo/commands/web/web-retentionlabel-list.js +63 -0
  7. package/dist/m365/spo/commands.js +3 -0
  8. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.md +61 -0
  9. package/docs/docs/cmd/spo/list/{list-label-get.md → list-retentionlabel-get.md} +17 -11
  10. package/docs/docs/cmd/spo/list/list-retentionlabel-set.md +65 -0
  11. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +9 -5
  12. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +42 -0
  13. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +25 -3
  14. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +22 -0
  15. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +6 -2
  16. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +5 -1
  17. package/docs/docs/cmd/spo/page/page-add.md +13 -9
  18. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.md +6 -2
  19. package/docs/docs/cmd/spo/page/page-column-get.md +68 -5
  20. package/docs/docs/cmd/spo/page/page-column-list.md +36 -4
  21. package/docs/docs/cmd/spo/page/page-control-get.md +70 -3
  22. package/docs/docs/cmd/spo/page/page-control-list.md +69 -3
  23. package/docs/docs/cmd/spo/page/page-control-set.md +11 -7
  24. package/docs/docs/cmd/spo/page/page-copy.md +65 -4
  25. package/docs/docs/cmd/spo/page/page-get.md +100 -4
  26. package/docs/docs/cmd/spo/page/page-header-set.md +17 -13
  27. package/docs/docs/cmd/spo/page/page-list.md +122 -1
  28. package/docs/docs/cmd/spo/page/page-remove.md +9 -5
  29. package/docs/docs/cmd/spo/page/page-section-add.md +10 -6
  30. package/docs/docs/cmd/spo/page/page-section-get.md +36 -4
  31. package/docs/docs/cmd/spo/page/page-section-list.md +38 -3
  32. package/docs/docs/cmd/spo/page/page-set.md +10 -10
  33. package/docs/docs/cmd/spo/page/page-template-list.md +58 -1
  34. package/docs/docs/cmd/spo/page/page-text-add.md +9 -5
  35. package/docs/docs/cmd/spo/propertybag/propertybag-get.md +28 -8
  36. package/docs/docs/cmd/spo/propertybag/propertybag-list.md +35 -7
  37. package/docs/docs/cmd/spo/propertybag/propertybag-remove.md +13 -9
  38. package/docs/docs/cmd/spo/propertybag/propertybag-set.md +13 -5
  39. package/docs/docs/cmd/spo/report/report-activityfilecounts.md +34 -2
  40. package/docs/docs/cmd/spo/report/report-activitypages.md +31 -2
  41. package/docs/docs/cmd/spo/report/report-activityusercounts.md +35 -2
  42. package/docs/docs/cmd/spo/report/report-activityuserdetail.md +40 -3
  43. package/docs/docs/cmd/spo/report/report-siteusagedetail.md +43 -3
  44. package/docs/docs/cmd/spo/report/report-siteusagefilecounts.md +33 -2
  45. package/docs/docs/cmd/spo/report/report-siteusagepages.md +32 -2
  46. package/docs/docs/cmd/spo/report/report-siteusagesitecounts.md +33 -2
  47. package/docs/docs/cmd/spo/report/report-siteusagestorage.md +32 -2
  48. package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md +10 -6
  49. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +80 -2
  50. package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +76 -2
  51. package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.md +9 -5
  52. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.md +39 -2
  53. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.md +32 -0
  54. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.md +6 -2
  55. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-approve.md +14 -74
  56. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-deny.md +6 -2
  57. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-permissionrequest-list.md +30 -0
  58. package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.md +36 -2
  59. package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +74 -0
  60. package/package.json +1 -1
  61. package/docs/docs/cmd/spo/list/list-label-set.md +0 -55
@@ -11,16 +11,16 @@ m365 spo page copy [options]
11
11
  ## Options
12
12
 
13
13
  `--sourceName <sourceName>`
14
- : The name of the source file
14
+ : The name of the source file.
15
15
 
16
16
  `--targetUrl <targetUrl>`
17
- : The URL of the target file. You can specify page's name or relative- or absolute URL
17
+ : The URL of the target file. You can specify page's name or relative- or absolute URL.
18
18
 
19
19
  `--overwrite`
20
- : Overwrite the target page when it already exists
20
+ : Overwrite the target page when it already exists.
21
21
 
22
22
  `-u, --webUrl <webUrl>`
23
- : URL of the site where the page to retrieve is located
23
+ : URL of the site where the page to retrieve is located.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -53,3 +53,64 @@ Copy the page to another site
53
53
  ```sh
54
54
  m365 spo page copy --webUrl https://contoso.sharepoint.com/sites/team-a --sourceName "templates/PageTemplate.aspx" --targetUrl "https://contoso.sharepoint.com/sites/team-b/sitepages/page.aspx"
55
55
  ```
56
+
57
+
58
+ ## Response
59
+
60
+ === "JSON"
61
+
62
+ ```json
63
+ {
64
+ "AbsoluteUrl": "https://contoso.sharepoint.com/sites/SPDemo/SitePages/home-copy.aspx",
65
+ "AuthorByline": null,
66
+ "BannerImageUrl": "https://contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png",
67
+ "BannerThumbnailUrl": "https://media.akamai.odsp.cdn.office.net/contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png",
68
+ "CallToAction": "",
69
+ "Categories": null,
70
+ "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
71
+ "Description": null,
72
+ "DoesUserHaveEditPermission": true,
73
+ "FileName": "home-copy.aspx",
74
+ "FirstPublished": "0001-01-01T08:00:00Z",
75
+ "Id": 23,
76
+ "IsPageCheckedOutToCurrentUser": false,
77
+ "IsWebWelcomePage": false,
78
+ "Modified": "2022-11-26T10:11:30Z",
79
+ "PageLayoutType": "Article",
80
+ "Path": {
81
+ "DecodedUrl": "SitePages/home-copy.aspx"
82
+ },
83
+ "PromotedState": 0,
84
+ "Title": "new-page",
85
+ "TopicHeader": null,
86
+ "UniqueId": "3c4b010b-7043-4b2b-b7eb-e6110d1bebac",
87
+ "Url": "SitePages/home-copy.aspx",
88
+ "Version": "0.1",
89
+ "VersionInfo": {
90
+ "LastVersionCreated": "0001-01-01T00:00:00",
91
+ "LastVersionCreatedBy": ""
92
+ },
93
+ "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\"}",
94
+ "CanvasContent1": "[{\"controlType\":3,\"displayMode\":2,\"id\":\"7558d804-0334-49ca-b14a-53870cf6caae\",\"position\":{\"controlIndex\":1,\"sectionIndex\":1,\"zoneIndex\":1,\"sectionFactor\":12,\"layoutIndex\":1},\"webPartId\":\"e377ea37-9047-43b9-8cdb-a761be2f8e09\",\"emphasis\":{},\"webPartData\":{\"dataVersion\":\"1.0\",\"description\":\"Display a location on a map using Bing Maps.\",\"id\":\"e377ea37-9047-43b9-8cdb-a761be2f8e09\",\"instanceId\":\"7558d804-0334-49ca-b14a-53870cf6caae\",\"properties\":{\"pushPins\":[],\"maxNumberOfPushPins\":1,\"shouldShowPushPinTitle\":true,\"zoomLevel\":12,\"mapType\":\"road\"},\"title\":\"Bing Maps\",\"serverProcessedContent\":{\"htmlStrings\":{},\"searchablePlainTexts\":{},\"imageSources\":{},\"links\":{}}}},{\"controlType\":0,\"pageSettingsSlice\":{\"isDefaultDescription\":true,\"isDefaultThumbnail\":true}}]",
95
+ "CoAuthState": null,
96
+ "Language": "en-us",
97
+ "LayoutWebpartsContent": null,
98
+ "SitePageFlags": ""
99
+ }
100
+ ```
101
+
102
+ === "Text"
103
+
104
+ ```text
105
+ Id : 24
106
+ PageLayoutType: Article
107
+ Title : new-page
108
+ Url : SitePages/home-copy.aspx
109
+ ```
110
+
111
+ === "CSV"
112
+
113
+ ```csv
114
+ Id,PageLayoutType,Title,Url
115
+ 25,Article,new-page,SitePages/home-copy.aspx
116
+ ```
@@ -11,13 +11,13 @@ m365 spo page get [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --name <name>`
14
- : Name of the page to retrieve
14
+ : Name of the page to retrieve.
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
  `--metadataOnly`
20
- : Specify to only retrieve the metadata without the section and control information
20
+ : Specify to only retrieve the metadata without the section and control information.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -27,7 +27,7 @@ If the specified name doesn't refer to an existing modern page, you will get a `
27
27
 
28
28
  ## Examples
29
29
 
30
- Get information about the modern page with name _home.aspx_
30
+ Get information about the modern page
31
31
 
32
32
  ```sh
33
33
  m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx
@@ -38,3 +38,99 @@ Get all the metadata from the modern page, without the section and control count
38
38
  ```sh
39
39
  m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx --metadataOnly
40
40
  ```
41
+
42
+ ## Response
43
+
44
+ === "JSON"
45
+
46
+ ```json
47
+ {
48
+ "ListItemAllFields": {
49
+ "CommentsDisabled": true,
50
+ "FileSystemObjectType": 0,
51
+ "Id": 21,
52
+ "ServerRedirectedEmbedUri": null,
53
+ "ServerRedirectedEmbedUrl": "",
54
+ "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800F1678937A82C3142BEF3C962300813B5",
55
+ "OData__ModerationComments": null,
56
+ "ComplianceAssetId": null,
57
+ "WikiField": null,
58
+ "Title": "new-page",
59
+ "ClientSideApplicationId": "b6917cb1-93a0-4b97-a84d-7cf49975d4ec",
60
+ "PageLayoutType": "Article",
61
+ "CanvasContent1": "<div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;3,&quot;displayMode&quot;&#58;2,&quot;id&quot;&#58;&quot;7558d804-0334-49ca-b14a-53870cf6caae&quot;,&quot;position&quot;&#58;&#123;&quot;controlIndex&quot;&#58;1,&quot;sectionIndex&quot;&#58;1,&quot;zoneIndex&quot;&#58;1,&quot;sectionFactor&quot;&#58;12,&quot;layoutIndex&quot;&#58;1&#125;,&quot;webPartId&quot;&#58;&quot;e377ea37-9047-43b9-8cdb-a761be2f8e09&quot;,&quot;emphasis&quot;&#58;&#123;&#125;&#125;\"><div data-sp-webpart=\"\" data-sp-webpartdataversion=\"1.0\" data-sp-webpartdata=\"&#123;&quot;dataVersion&quot;&#58;&quot;1.0&quot;,&quot;description&quot;&#58;&quot;Display a location on a map using Bing Maps.&quot;,&quot;id&quot;&#58;&quot;e377ea37-9047-43b9-8cdb-a761be2f8e09&quot;,&quot;instanceId&quot;&#58;&quot;7558d804-0334-49ca-b14a-53870cf6caae&quot;,&quot;properties&quot;&#58;&#123;&quot;pushPins&quot;&#58;[],&quot;maxNumberOfPushPins&quot;&#58;1,&quot;shouldShowPushPinTitle&quot;&#58;true,&quot;zoomLevel&quot;&#58;12,&quot;mapType&quot;&#58;&quot;road&quot;&#125;,&quot;title&quot;&#58;&quot;Bing Maps&quot;&#125;\"><div data-sp-componentid=\"e377ea37-9047-43b9-8cdb-a761be2f8e09\"></div><div data-sp-htmlproperties=\"\"></div></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;0,&quot;pageSettingsSlice&quot;&#58;&#123;&quot;isDefaultDescription&quot;&#58;true,&quot;isDefaultThumbnail&quot;&#58;true&#125;&#125;\"></div></div>",
62
+ "BannerImageUrl": {
63
+ "Description": "https://contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png",
64
+ "Url": "https://contoso.sharepoint.com/_layouts/15/images/sitepagethumbnail.png"
65
+ },
66
+ "Description": null,
67
+ "PromotedState": 0,
68
+ "FirstPublishedDate": null,
69
+ "LayoutWebpartsContent": null,
70
+ "OData__AuthorBylineId": null,
71
+ "_AuthorBylineStringId": null,
72
+ "OData__TopicHeader": null,
73
+ "OData__SPSitePageFlags": null,
74
+ "OData__OriginalSourceUrl": null,
75
+ "OData__OriginalSourceSiteId": null,
76
+ "OData__OriginalSourceWebId": null,
77
+ "OData__OriginalSourceListId": null,
78
+ "OData__OriginalSourceItemId": null,
79
+ "OData__SPCallToAction": null,
80
+ "OData__ModerationStatus": 3,
81
+ "ID": 21,
82
+ "Created": "2022-11-26T01:51:46",
83
+ "AuthorId": 7,
84
+ "Modified": "2022-11-26T01:55:47",
85
+ "EditorId": 7,
86
+ "OData__CopySource": null,
87
+ "CheckoutUserId": null,
88
+ "OData__UIVersionString": "0.4",
89
+ "GUID": "c8e64e90-e546-4b67-ad05-44e76dac54fb"
90
+ },
91
+ "CheckInComment": "",
92
+ "CheckOutType": 2,
93
+ "ContentTag": "{C431F2EF-447C-4F72-BC3E-ED2687456C33},8,3",
94
+ "CustomizedPageStatus": 2,
95
+ "ETag": "\"{C431F2EF-447C-4F72-BC3E-ED2687456C33},8\"",
96
+ "Exists": true,
97
+ "IrmEnabled": false,
98
+ "Length": "4106",
99
+ "Level": 2,
100
+ "LinkingUri": null,
101
+ "LinkingUrl": "",
102
+ "MajorVersion": 0,
103
+ "MinorVersion": 4,
104
+ "Name": "new-page.aspx",
105
+ "ServerRelativeUrl": "/sites/SPDemo/SitePages/new-page.aspx",
106
+ "TimeCreated": "2022-11-26T09:51:46Z",
107
+ "TimeLastModified": "2022-11-26T09:55:46Z",
108
+ "Title": "new-page",
109
+ "UIVersion": 4,
110
+ "UIVersionLabel": "0.4",
111
+ "UniqueId": "c431f2ef-447c-4f72-bc3e-ed2687456c33",
112
+ "commentsDisabled": true,
113
+ "title": "new-page",
114
+ "layoutType": "Article",
115
+ "canvasContentJson": "[{\"controlType\":3,\"displayMode\":2,\"id\":\"7558d804-0334-49ca-b14a-53870cf6caae\",\"position\":{\"controlIndex\":1,\"sectionIndex\":1,\"zoneIndex\":1,\"sectionFactor\":12,\"layoutIndex\":1},\"webPartId\":\"e377ea37-9047-43b9-8cdb-a761be2f8e09\",\"emphasis\":{},\"webPartData\":{\"dataVersion\":\"1.0\",\"description\":\"Display a location on a map using Bing Maps.\",\"id\":\"e377ea37-9047-43b9-8cdb-a761be2f8e09\",\"instanceId\":\"7558d804-0334-49ca-b14a-53870cf6caae\",\"properties\":{\"pushPins\":[],\"maxNumberOfPushPins\":1,\"shouldShowPushPinTitle\":true,\"zoomLevel\":12,\"mapType\":\"road\"},\"title\":\"Bing Maps\",\"serverProcessedContent\":{\"htmlStrings\":{},\"searchablePlainTexts\":{},\"imageSources\":{},\"links\":{}}}},{\"controlType\":0,\"pageSettingsSlice\":{\"isDefaultDescription\":true,\"isDefaultThumbnail\":true}}]",
116
+ "numControls": 2,
117
+ "numSections": 1
118
+ }
119
+ ```
120
+
121
+ === "Text"
122
+
123
+ ```text
124
+ commentsDisabled: true
125
+ layoutType : Article
126
+ numControls : 2
127
+ numSections : 1
128
+ title : new-page
129
+ ```
130
+
131
+ === "CSV"
132
+
133
+ ```csv
134
+ commentsDisabled,numSections,numControls,title,layoutType
135
+ 1,1,2,new-page,Article
136
+ ```
@@ -11,43 +11,43 @@ m365 spo page header set [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --pageName <pageName>`
14
- : Name of the page to set the header for
14
+ : Name of the page to set the header for.
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
  `-t, --type [type]`
20
- : Type of header, allowed values `None,Default,Custom`. Default `Default`
20
+ : Type of header, allowed values `None`, `Default`, `Custom`. Default `Default`.
21
21
 
22
22
  `--imageUrl [imageUrl]`
23
- : Server-relative URL of the image to use in the header. Image must be stored in the same site collection as the page
23
+ : Server-relative URL of the image to use in the header. Image must be stored in the same site collection as the page.
24
24
 
25
25
  `--altText [altText]`
26
- : Header image alt text
26
+ : Header image alt text.
27
27
 
28
28
  `-x, --translateX [translateX]`
29
- : X focal point of the header image
29
+ : X focal point of the header image.
30
30
 
31
31
  `-y, --translateY [translateY]`
32
- : Y focal point of the header image
32
+ : Y focal point of the header image.
33
33
 
34
34
  `--layout [layout]`
35
- : Layout to use in the header. Allowed values `FullWidthImage,NoImage,ColorBlock,CutInShape`. Default `FullWidthImage`
35
+ : Layout to use in the header. Allowed values `FullWidthImage`, `NoImage`, `ColorBlock`, `CutInShape`. Default `FullWidthImage`.
36
36
 
37
37
  `--textAlignment [textAlignment]`
38
- : How to align text in the header. Allowed values `Center,Left`. Default `Left`
38
+ : How to align text in the header. Allowed values `Center`, `Left`. Default `Left`.
39
39
 
40
40
  `--showTopicHeader`
41
- : Set, to show the topic header
41
+ : Set, to show the topic header.
42
42
 
43
43
  `--showPublishDate`
44
- : Set, to show the publishing date
44
+ : Set, to show the publishing date.
45
45
 
46
46
  `--topicHeader [topicHeader]`
47
- : Text to show in the topic header, when showTopicHeader is set
47
+ : Text to show in the topic header, when `showTopicHeader` is set.
48
48
 
49
49
  `--authors [authors]`
50
- : Comma-separated list of page authors to show in the header
50
+ : Comma-separated list of page authors to show in the header.
51
51
 
52
52
  --8<-- "docs/cmd/_global.md"
53
53
 
@@ -80,3 +80,7 @@ Center the page title in the header and show the publishing date
80
80
  ```sh
81
81
  m365 spo page header set --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --textAlignment Center --showPublishDate
82
82
  ```
83
+
84
+ ## Response
85
+
86
+ The command won't return a response on success.
@@ -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