@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,16 +11,16 @@ m365 spo page column 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 column information of
17
+ : Name of the page to get column information of.
18
18
 
19
19
  `-s, --section <section>`
20
- : ID of the section where the column is located
20
+ : ID of the section where the column is located.
21
21
 
22
22
  `-c, --column <column>`
23
- : ID of the column for which to retrieve more information
23
+ : ID of the column for which to retrieve more information.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
26
26
 
@@ -30,8 +30,71 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
30
30
 
31
31
  ## Examples
32
32
 
33
- Get information about the first column in the first section of a modern page with name _home.aspx_
33
+ Get information about the first column in the first section of a modern page
34
34
 
35
35
  ```sh
36
36
  m365 spo page column get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1 --column 1
37
37
  ```
38
+
39
+ ## Response
40
+
41
+ === "JSON"
42
+
43
+ ```json
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
+ "controls": [
50
+ {
51
+ "controlType": 3,
52
+ "dataVersion": "1.0",
53
+ "order": 1,
54
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
55
+ "controlData": {
56
+ "controlType": 3,
57
+ "displayMode": 2,
58
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
59
+ "position": {
60
+ "controlIndex": 1,
61
+ "sectionIndex": 1,
62
+ "zoneIndex": 1,
63
+ "sectionFactor": 12,
64
+ "layoutIndex": 1
65
+ },
66
+ "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
67
+ "emphasis": {}
68
+ },
69
+ "title": "Bing Maps",
70
+ "description": "Display a location on a map using Bing Maps.",
71
+ "propertieJson": {
72
+ "pushPins": [],
73
+ "maxNumberOfPushPins": 1,
74
+ "shouldShowPushPinTitle": true,
75
+ "zoomLevel": 12,
76
+ "mapType": "road"
77
+ },
78
+ "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
79
+ "htmlProperties": "",
80
+ "serverProcessedContent": null,
81
+ "canvasDataVersion": "1.0"
82
+ }
83
+ ]
84
+ }
85
+ ```
86
+
87
+ === "Text"
88
+
89
+ ```text
90
+ controls: 7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
91
+ factor : 12
92
+ order : 1
93
+ ```
94
+
95
+ === "CSV"
96
+
97
+ ```csv
98
+ factor,order,controls
99
+ 12,1,7558d804-0334-49ca-b14a-53870cf6caae (Bing Maps)
100
+ ```
@@ -11,13 +11,13 @@ m365 spo page column 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 columns of
17
+ : Name of the page to list columns of.
18
18
 
19
19
  `-s, --section <sectionId>`
20
- : ID of the section for which to list columns
20
+ : ID of the section for which to list columns.
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
- List columns in the first section of a modern page with name _home.aspx_
30
+ List columns in the first section of a modern page
31
31
 
32
32
  ```sh
33
33
  m365 spo page column list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1
34
34
  ```
35
+
36
+
37
+ ## Response
38
+
39
+ === "JSON"
40
+
41
+ ```json
42
+ [
43
+ {
44
+ "factor": 12,
45
+ "order": 1,
46
+ "dataVersion": "1.0",
47
+ "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;",
48
+ "controls": 1
49
+ }
50
+ ]
51
+ ```
52
+
53
+ === "Text"
54
+
55
+ ```text
56
+ controls: 1
57
+ factor : 12
58
+ order : 1
59
+ ```
60
+
61
+ === "CSV"
62
+
63
+ ```csv
64
+ factor,order,controls
65
+ 12,1,1
66
+ ```
@@ -11,13 +11,13 @@ m365 spo page control get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id <id>`
14
- : ID of the control to retrieve information for
14
+ : ID of the control to retrieve information for.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page where the control is located
17
+ : Name of the page where the control is located.
18
18
 
19
19
  `-u, --webUrl <webUrl>`
20
- : URL of the site where the page to retrieve is located
20
+ : URL of the site where the page to retrieve is located.
21
21
 
22
22
  --8<-- "docs/cmd/_global.md"
23
23
 
@@ -32,3 +32,70 @@ Get information about the control with ID _3ede60d3-dc2c-438b-b5bf-cc40bb2351e1_
32
32
  ```sh
33
33
  m365 spo page control get --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
34
34
  ```
35
+
36
+
37
+ ## Response
38
+
39
+ === "JSON"
40
+
41
+ ```json
42
+ {
43
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
44
+ "type": "Client-side web part",
45
+ "title": "Bing Maps",
46
+ "controlType": 3,
47
+ "order": 1,
48
+ "controlData": {
49
+ "controlType": 3,
50
+ "displayMode": 2,
51
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
52
+ "position": {
53
+ "controlIndex": 1,
54
+ "sectionIndex": 1,
55
+ "zoneIndex": 1,
56
+ "sectionFactor": 12,
57
+ "layoutIndex": 1
58
+ },
59
+ "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
60
+ "emphasis": {},
61
+ "webPartData": {
62
+ "dataVersion": "1.0",
63
+ "description": "Display a location on a map using Bing Maps.",
64
+ "id": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
65
+ "instanceId": "7558d804-0334-49ca-b14a-53870cf6caae",
66
+ "properties": {
67
+ "pushPins": [],
68
+ "maxNumberOfPushPins": 1,
69
+ "shouldShowPushPinTitle": true,
70
+ "zoomLevel": 12,
71
+ "mapType": "road"
72
+ },
73
+ "title": "Bing Maps",
74
+ "serverProcessedContent": {
75
+ "htmlStrings": {},
76
+ "searchablePlainTexts": {},
77
+ "imageSources": {},
78
+ "links": {}
79
+ }
80
+ }
81
+ }
82
+ }
83
+ ```
84
+
85
+ === "Text"
86
+
87
+ ```text
88
+ controlData: {"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":{}}}}
89
+ controlType: 3
90
+ id : 7558d804-0334-49ca-b14a-53870cf6caae
91
+ order : 1
92
+ title : Bing Maps
93
+ type : Client-side web part
94
+ ```
95
+
96
+ === "CSV"
97
+
98
+ ```csv
99
+ id,type,title,controlType,order,controlData
100
+ 7558d804-0334-49ca-b14a-53870cf6caae,Client-side web part,Bing Maps,3,1,"{""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"":{}}}}"
101
+ ```
@@ -11,10 +11,10 @@ m365 spo page control list [options]
11
11
  ## Options
12
12
 
13
13
  `-n, --pageName <pageName>`
14
- : Name of the page to list controls of
14
+ : Name of the page to list controls of.
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
  --8<-- "docs/cmd/_global.md"
20
20
 
@@ -24,8 +24,74 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
24
24
 
25
25
  ## Examples
26
26
 
27
- List controls on the modern page with name _home.aspx_
27
+ List controls on the modern page
28
28
 
29
29
  ```sh
30
30
  m365 spo page control list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
31
31
  ```
32
+
33
+
34
+ ## Response
35
+
36
+ === "JSON"
37
+
38
+ ```json
39
+ [
40
+ {
41
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
42
+ "type": "Client-side web part",
43
+ "title": "Bing Maps",
44
+ "controlType": 3,
45
+ "order": 1,
46
+ "controlData": {
47
+ "controlType": 3,
48
+ "displayMode": 2,
49
+ "id": "7558d804-0334-49ca-b14a-53870cf6caae",
50
+ "position": {
51
+ "controlIndex": 1,
52
+ "sectionIndex": 1,
53
+ "zoneIndex": 1,
54
+ "sectionFactor": 12,
55
+ "layoutIndex": 1
56
+ },
57
+ "webPartId": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
58
+ "emphasis": {},
59
+ "webPartData": {
60
+ "dataVersion": "1.0",
61
+ "description": "Display a location on a map using Bing Maps.",
62
+ "id": "e377ea37-9047-43b9-8cdb-a761be2f8e09",
63
+ "instanceId": "7558d804-0334-49ca-b14a-53870cf6caae",
64
+ "properties": {
65
+ "pushPins": [],
66
+ "maxNumberOfPushPins": 1,
67
+ "shouldShowPushPinTitle": true,
68
+ "zoomLevel": 12,
69
+ "mapType": "road"
70
+ },
71
+ "title": "Bing Maps",
72
+ "serverProcessedContent": {
73
+ "htmlStrings": {},
74
+ "searchablePlainTexts": {},
75
+ "imageSources": {},
76
+ "links": {}
77
+ }
78
+ }
79
+ }
80
+ }
81
+ ]
82
+ ```
83
+
84
+ === "Text"
85
+
86
+ ```text
87
+ id title type
88
+ ------------------------------------ --------- ---------------------
89
+ 7558d804-0334-49ca-b14a-53870cf6caae Bing Maps Client-side web part
90
+ ```
91
+
92
+ === "CSV"
93
+
94
+ ```csv
95
+ id,type,title
96
+ 7558d804-0334-49ca-b14a-53870cf6caae,Client-side web part,Bing Maps
97
+ ```
@@ -11,19 +11,19 @@ m365 spo page control set [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id <id>`
14
- : ID of the control to update properties of
14
+ : ID of the control to update properties of.
15
15
 
16
16
  `-n, --pageName <pageName>`
17
- : Name of the page where the control is located
17
+ : Name of the page where the control is located.
18
18
 
19
19
  `-u, --webUrl <webUrl>`
20
- : URL of the site where the page is located
20
+ : URL of the site where the page is located.
21
21
 
22
22
  `--webPartData [webPartData]`
23
- : JSON string with web part data as retrieved from the web part maintenance mode. Specify `webPartProperties` or `webPartData` but not both
23
+ : JSON string with web part data as retrieved from the web part maintenance mode. Specify either `webPartProperties` or `webPartData` but not both.
24
24
 
25
25
  `--webPartProperties [webPartProperties]`
26
- : JSON string with web part data as retrieved from the web part maintenance mode. Specify `webPartProperties` or `webPartData` but not both
26
+ : JSON string with web part data as retrieved from the web part maintenance mode. Specify either `webPartProperties` or `webPartData` but not both.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
@@ -36,14 +36,18 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
36
36
 
37
37
  ## Examples
38
38
 
39
- Update web part data for the control with ID _3ede60d3-dc2c-438b-b5bf-cc40bb2351e1_ placed on a modern page with name _home.aspx_
39
+ Update web part data for the control, placed on a modern page
40
40
 
41
41
  ```sh
42
42
  m365 spo page control set --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --webPartData '{"title":"New WP Title","properties": {"description": "New description"}}'
43
43
  ```
44
44
 
45
- Update web part properties for the control with ID _3ede60d3-dc2c-438b-b5bf-cc40bb2351e1_ placed on a modern page with name _home.aspx_
45
+ Update web part properties for the control, placed on a modern page
46
46
 
47
47
  ```sh
48
48
  m365 spo page control set --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --webPartProperties '{"description": "New description"}'
49
49
  ```
50
+
51
+ ## Response
52
+
53
+ The command won't return a response on success.
@@ -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.