@pnp/cli-microsoft365 6.2.0 → 6.3.0-beta.1336e33

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 (164) hide show
  1. package/.eslintrc.js +8 -0
  2. package/dist/Auth.js +0 -18
  3. package/dist/Command.js +12 -1
  4. package/dist/cli/Cli.js +4 -1
  5. package/dist/m365/aad/commands/group/group-list.js +2 -1
  6. package/dist/m365/base/O365MgmtCommand.js +10 -0
  7. package/dist/m365/context/commands/option/option-list.js +54 -0
  8. package/dist/m365/context/commands.js +1 -0
  9. package/dist/m365/file/commands/convert/convert-pdf.js +7 -6
  10. package/dist/m365/flow/commands/run/run-list.js +55 -3
  11. package/dist/m365/graph/commands/changelog/changelog-list.js +3 -2
  12. package/dist/m365/onenote/commands/notebook/notebook-list.js +50 -53
  13. package/dist/m365/onenote/commands/page/page-list.js +2 -16
  14. package/dist/m365/outlook/commands/mail/mail-send.js +3 -2
  15. package/dist/m365/outlook/commands/message/message-get.js +4 -3
  16. package/dist/m365/planner/commands/plan/plan-add.js +20 -6
  17. package/dist/m365/planner/commands/plan/plan-get.js +40 -26
  18. package/dist/m365/planner/commands/plan/plan-list.js +24 -14
  19. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  20. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  21. package/dist/m365/planner/commands/roster/roster-add.js +47 -0
  22. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  23. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  24. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  25. package/dist/m365/planner/commands/roster/roster-remove.js +88 -0
  26. package/dist/m365/planner/commands/task/task-add.js +3 -0
  27. package/dist/m365/planner/commands/task/task-checklistitem-add.js +2 -1
  28. package/dist/m365/planner/commands/task/task-checklistitem-list.js +2 -1
  29. package/dist/m365/planner/commands.js +5 -0
  30. package/dist/m365/pp/commands/solution/solution-get.js +2 -1
  31. package/dist/m365/pp/commands/solution/solution-list.js +2 -1
  32. package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
  33. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +76 -0
  34. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +47 -0
  35. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +92 -0
  36. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  37. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +70 -0
  38. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +44 -0
  39. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  40. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  41. package/dist/m365/purview/commands.js +9 -0
  42. package/dist/m365/spfx/commands/project/WebApiPermissionRequests.js +3 -0
  43. package/dist/m365/spfx/commands/project/project-permissions-grant.js +81 -0
  44. package/dist/m365/spfx/commands.js +3 -2
  45. package/dist/m365/spo/commands/app/app-add.js +2 -1
  46. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  47. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  48. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  49. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  50. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  51. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +2 -1
  52. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  53. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  54. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  55. package/dist/m365/spo/commands/file/file-sharinglink-list.js +9 -29
  56. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  57. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  58. package/dist/m365/spo/commands/group/group-list.js +2 -1
  59. package/dist/m365/spo/commands/hubsite/hubsite-get.js +1 -1
  60. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  61. package/dist/m365/spo/commands/listitem/listitem-list.js +2 -1
  62. package/dist/m365/spo/commands/navigation/navigation-node-add.js +17 -3
  63. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  64. package/dist/m365/spo/commands/navigation/navigation-node-list.js +4 -7
  65. package/dist/m365/spo/commands/navigation/navigation-node-set.js +118 -0
  66. package/dist/m365/spo/commands/page/page-column-get.js +2 -1
  67. package/dist/m365/spo/commands/page/page-column-list.js +2 -1
  68. package/dist/m365/spo/commands/page/page-section-get.js +2 -1
  69. package/dist/m365/spo/commands/page/page-section-list.js +2 -1
  70. package/dist/m365/spo/commands/site/site-apppermission-add.js +2 -14
  71. package/dist/m365/spo/commands/site/site-apppermission-get.js +2 -14
  72. package/dist/m365/spo/commands/site/site-apppermission-list.js +2 -14
  73. package/dist/m365/spo/commands/site/site-apppermission-remove.js +2 -14
  74. package/dist/m365/spo/commands/site/site-apppermission-set.js +2 -14
  75. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  76. package/dist/m365/spo/commands/spo-search.js +2 -1
  77. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  78. package/dist/m365/spo/commands/term/term-list.js +2 -1
  79. package/dist/m365/spo/commands/userprofile/userprofile-get.js +2 -2
  80. package/dist/m365/spo/commands/web/web-set.js +11 -4
  81. package/dist/m365/spo/commands.js +6 -0
  82. package/dist/m365/teams/commands/chat/chat-list.js +4 -4
  83. package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +5 -5
  84. package/dist/m365/teams/commands/meeting/meeting-get.js +5 -5
  85. package/dist/m365/teams/commands/meeting/meeting-list.js +5 -4
  86. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  87. package/dist/m365/teams/commands/user/user-app-list.js +2 -1
  88. package/dist/m365/todo/commands/task/task-get.js +2 -1
  89. package/dist/m365/todo/commands/task/task-list.js +2 -1
  90. package/dist/m365/yammer/commands/yammer-search.js +2 -1
  91. package/dist/utils/accessToken.js +1 -1
  92. package/dist/utils/planner.js +16 -5
  93. package/dist/utils/spo.js +116 -0
  94. package/docs/docs/cmd/aad/app/app-list.md +3 -0
  95. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  96. package/docs/docs/cmd/context/option/option-list.md +63 -0
  97. package/docs/docs/cmd/flow/run/run-list.md +21 -0
  98. package/docs/docs/cmd/login.md +26 -0
  99. package/docs/docs/cmd/logout.md +4 -0
  100. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  101. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  102. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  103. package/docs/docs/cmd/pa/environment/environment-get.md +18 -0
  104. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  105. package/docs/docs/cmd/planner/plan/plan-add.md +17 -6
  106. package/docs/docs/cmd/planner/plan/plan-get.md +21 -7
  107. package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
  108. package/docs/docs/cmd/planner/plan/plan-remove.md +4 -0
  109. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  110. package/docs/docs/cmd/planner/roster/roster-add.md +60 -0
  111. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  112. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  113. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  114. package/docs/docs/cmd/planner/roster/roster-remove.md +48 -0
  115. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  116. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  117. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  118. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  119. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  120. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  121. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  122. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  123. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  124. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  125. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  126. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  127. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  128. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  129. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  130. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  131. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  132. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  133. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  134. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  135. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  136. package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
  137. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  138. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  139. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +42 -0
  140. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  141. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +100 -0
  142. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  143. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  144. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  145. package/docs/docs/cmd/request.md +74 -0
  146. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +65 -0
  147. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  148. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  149. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  150. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  151. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +2 -2
  152. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +2 -2
  153. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +18 -3
  154. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  155. package/docs/docs/cmd/spo/navigation/navigation-node-list.md +30 -0
  156. package/docs/docs/cmd/spo/navigation/navigation-node-remove.md +1 -1
  157. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +59 -0
  158. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  159. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  160. package/docs/docs/cmd/spo/web/web-set.md +9 -0
  161. package/docs/docs/cmd/status.md +46 -0
  162. package/docs/docs/cmd/version.md +26 -0
  163. package/npm-shrinkwrap.json +913 -878
  164. package/package.json +13 -13
@@ -74,3 +74,77 @@ Call the Microsoft Graph to get a profile photo.
74
74
  ```sh
75
75
  m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
76
76
  ```
77
+
78
+ ## Response
79
+
80
+ The responses below are an example based on the `url` option with the value 'https://graph.microsoft.com/v1.0/me'. The output may differ based on the `url` options
81
+
82
+ === "JSON"
83
+
84
+ ```json
85
+ {
86
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
87
+ "businessPhones": [
88
+ "123456789"
89
+ ],
90
+ "displayName": "John Doe",
91
+ "givenName": "John",
92
+ "jobTitle": null,
93
+ "mail": "john.doe@contoso.onmicrosoft.com",
94
+ "mobilePhone": null,
95
+ "officeLocation": null,
96
+ "preferredLanguage": "en-US",
97
+ "surname": "Doe",
98
+ "userPrincipalName": "john.doe@contoso.onmicrosoft.com",
99
+ "id": "1df1fffa-62b8-44a9-9c7c-49853f5b4ac6"
100
+ }
101
+ ```
102
+
103
+ === "Text"
104
+
105
+ ```text
106
+ @odata.context : https://graph.microsoft.com/v1.0/$metadata#users/$entity
107
+ businessPhones : ["123456789"]
108
+ displayName : John Doe
109
+ givenName : John
110
+ id : 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
111
+ jobTitle : null
112
+ mail : john.doe@contoso.onmicrosoft.com
113
+ mobilePhone : null
114
+ officeLocation : null
115
+ preferredLanguage: en-US
116
+ surname : Doe
117
+ userPrincipalName: john.doe@contoso.onmicrosoft.com
118
+ ```
119
+
120
+ === "CSV"
121
+
122
+ ```csv
123
+ @odata.context,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
124
+ https://graph.microsoft.com/v1.0/$metadata#users/$entity,"[""123456789""]",John Doe,John,,john.doe@contoso.onmicrosoft.com,,,en-US,Doe,john.doe@contoso.onmicrosoft.com,1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
125
+ ```
126
+
127
+ === "Markdown"
128
+
129
+ ```md
130
+ # request --url "https://graph.microsoft.com/v1.0/me" --method "get"
131
+
132
+ Date: 7/2/2023
133
+
134
+ ## John Doe (1df1fffa-62b8-44a9-9c7c-49853f5b4ac6)
135
+
136
+ Property | Value
137
+ ---------|-------
138
+ @odata.context | https://graph.microsoft.com/v1.0/$metadata#users/$entity
139
+ businessPhones | ["494594133"]
140
+ displayName | John Doe
141
+ givenName | John
142
+ jobTitle | null
143
+ mail | john.doe@contoso.onmicrosoft.com
144
+ mobilePhone | null
145
+ officeLocation | null
146
+ preferredLanguage | en-US
147
+ surname | Doe
148
+ userPrincipalName | john.doe@contoso.onmicrosoft.com
149
+ id | 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
150
+ ```
@@ -0,0 +1,65 @@
1
+ # spfx project permissions grant
2
+
3
+ Grant API permissions defined in the current SPFx project
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spfx project permissions grant [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Remarks
16
+
17
+ !!! important
18
+ Run this command in the folder where the project is located from where you want to grant the permissions.
19
+
20
+ This command grant the permissions defined in: _package-solution.json_.
21
+
22
+ ## Examples
23
+
24
+ Grant API permissions requested in the current SPFx project
25
+
26
+ ```sh
27
+ m365 spfx project permissions grant
28
+ ```
29
+
30
+ ## Response
31
+
32
+ === "JSON"
33
+
34
+ ```json
35
+ {
36
+ "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
37
+ "ConsentType": "AllPrincipals",
38
+ "IsDomainIsolated": false,
39
+ "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
40
+ "PackageName": null,
41
+ "Resource": "Microsoft Graph",
42
+ "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
43
+ "Scope": "Mail.Read"
44
+ }
45
+ ```
46
+
47
+ === "Text"
48
+
49
+ ```text
50
+ ClientId : 6004a642-185c-479a-992a-15d1c23e2229
51
+ ConsentType : AllPrincipals
52
+ IsDomainIsolated: false
53
+ ObjectId : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
54
+ PackageName : null
55
+ Resource : Microsoft Graph
56
+ ResourceId : a46b0017-21e2-4db1-bc69-ca63576a38d6
57
+ Scope : Mail.Read
58
+ ```
59
+
60
+ === "CSV"
61
+
62
+ ```csv
63
+ ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
64
+ 6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
65
+ ```
@@ -0,0 +1,56 @@
1
+ # spo applicationcustomizer add
2
+
3
+ Add an application customizer to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo applicationcustomizer add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the application customizer.
15
+
16
+ `-u, --webUrl <webUrl>`
17
+ : URL of the site.
18
+
19
+ `-i, --clientSideComponentId <clientSideComponentId>`
20
+ : Client-side component ID of the application customizer (GUID).
21
+
22
+ `--clientSideComponentProperties [clientSideComponentProperties]`
23
+ : JSON string with application customizer properties
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
30
+
31
+ ```sh
32
+ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
33
+ ```
34
+
35
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
36
+
37
+ !!! warning "Escaping JSON in PowerShell"
38
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
39
+
40
+ ## Examples
41
+
42
+ Adds an application customizer to the sales site.
43
+
44
+ ```sh
45
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
46
+ ```
47
+
48
+ Adds an application customizer to the sales site with some properties.
49
+
50
+ ```sh
51
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
52
+ ```
53
+
54
+ ## Response
55
+
56
+ The command won't return a response on success.
@@ -0,0 +1,46 @@
1
+ # spo file sharinglink clear
2
+
3
+ Removes sharing links of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink clear [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `-s, --scope [scope]`
23
+ : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes all sharing links from a file specified by id without prompting for confirmation
33
+
34
+ ```sh
35
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
36
+ ```
37
+
38
+ Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
39
+
40
+ ```sh
41
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
42
+ ```
43
+
44
+ ## Response
45
+
46
+ The command won't return a response on success.
@@ -19,7 +19,7 @@ m365 spo file sharinglink list [options]
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `--scope [scope]`
22
+ `-s, --scope [scope]`
23
23
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
@@ -0,0 +1,104 @@
1
+ # spo file sharinglink set
2
+
3
+ Updates a sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ `--expirationDateTime <expirationDateTime>`
26
+ : The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This options only works for anonymous links.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter
33
+
34
+ ```sh
35
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Document.docx" --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
36
+ ```
37
+
38
+ Updates an anonymous sharing link from a file by id with the expirationDateTime parameter
39
+
40
+ ```sh
41
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
42
+ ```
43
+
44
+ ## Response
45
+
46
+ === "JSON"
47
+
48
+ ```json
49
+ {
50
+ "id": "7c9f97c9-1bda-433c-9364-bb83e81771ee",
51
+ "roles": [
52
+ "read"
53
+ ],
54
+ "expirationDateTime": "2023-02-09T16:57:00Z",
55
+ "hasPassword": false,
56
+ "grantedToIdentitiesV2": [],
57
+ "grantedToIdentities": [],
58
+ "link": {
59
+ "scope": "anonymous",
60
+ "type": "view",
61
+ "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g",
62
+ "preventsDownload": false
63
+ }
64
+ }
65
+ ```
66
+
67
+ === "Text"
68
+
69
+ ```text
70
+ expirationDateTime : 2023-02-09T16:57:00Z
71
+ grantedToIdentities : []
72
+ grantedToIdentitiesV2: []
73
+ hasPassword : false
74
+ id : 7c9f97c9-1bda-433c-9364-bb83e81771ee
75
+ link : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g","preventsDownload":false}
76
+ roles : ["read"]
77
+ ```
78
+
79
+ === "CSV"
80
+
81
+ ```csv
82
+ id,roles,expirationDateTime,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
83
+ 7c9f97c9-1bda-433c-9364-bb83e81771ee,"[""read""]",2023-02-09T16:57:00Z,,[],[],"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g"",""preventsDownload"":false}"
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo file sharinglink set --webUrl "https://contoso.sharepoint.com" --fileUrl "/sites/demo/Shared Documents/Document.docx" --expirationDateTime "2023-02-09T16:57:00.000Z" --id "7c9f97c9-1bda-433c-9364-bb83e81771ee"
90
+
91
+ Date: 5/2/2023
92
+
93
+ ## 7c9f97c9-1bda-433c-9364-bb83e81771ee
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ id | 7c9f97c9-1bda-433c-9364-bb83e81771ee
98
+ roles | ["read"]
99
+ expirationDateTime | 2023-02-09T16:57:00Z
100
+ hasPassword | false
101
+ grantedToIdentitiesV2 | []
102
+ grantedToIdentities | []
103
+ link | {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-\_527\_fI9g","preventsDownload":false}
104
+ ```
@@ -14,10 +14,10 @@ m365 spo listitem attachment list [options]
14
14
  URL of the site from which the item should be retrieved
15
15
 
16
16
  `--listId [listId]`
17
- : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
17
+ : ID of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`
18
18
 
19
19
  `--listTitle [listTitle]`
20
- : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
20
+ : Title of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `--listUrl [listUrl]`
23
23
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
@@ -17,10 +17,10 @@ m365 spo listitem isrecord [options]
17
17
  : The ID of the list item to check if it is a record
18
18
 
19
19
  `-l, --listId [listId]`
20
- : ID of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
20
+ : ID of the list where the item should be checked. Specify either `listTitle`, `listId` or `listUrl`
21
21
 
22
22
  `-t, --listTitle [listTitle]`
23
- : Title of the list where the item should be added. Specify either `listTitle`, `listId` or `listUrl`
23
+ : Title of the list where the item should be checked. Specify either `listTitle`, `listId` or `listUrl`
24
24
 
25
25
  `--listUrl [listUrl]`
26
26
  : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
@@ -28,8 +28,15 @@ m365 spo navigation node add [options]
28
28
  `--isExternal`
29
29
  : Set, if the navigation node points to an external URL.
30
30
 
31
+ `--audienceIds [audienceIds]`
32
+ : Comma separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
33
+
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
36
+ ## Remarks
37
+
38
+ To enable/disable audience targeting for the navigation bar, use the [`spo web set`](../web/web-set.md) command.
39
+
33
40
  ## Examples
34
41
 
35
42
  Add a navigation node pointing to a SharePoint page to the top navigation
@@ -50,13 +57,21 @@ Add a navigation node below an existing node
50
57
  m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --parentNodeId 2010 --title About --url /sites/team-s/sitepages/about.aspx
51
58
  ```
52
59
 
60
+ Add a navigation node to the top navigation which is audience targetted
61
+
62
+ ```sh
63
+ m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar --title About --url /sites/team-s/sitepages/about.aspx --audienceIds "7aa4a1ca-4035-4f2f-bac7-7beada59b5ba,4bbf236f-a131-4019-b4a2-315902fcfa3a"
64
+ ```
65
+
53
66
  ## Response
54
67
 
55
68
  === "JSON"
56
69
 
57
70
  ```json
58
71
  {
59
- "AudienceIds": null,
72
+ "AudienceIds": [
73
+ "7aa4a1ca-4035-4f2f-bac7-7beada59b5ba"
74
+ ],
60
75
  "CurrentLCID": 1033,
61
76
  "Id": 2030,
62
77
  "IsDocLib": true,
@@ -71,7 +86,7 @@ m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-
71
86
  === "Text"
72
87
 
73
88
  ```text
74
- AudienceIds : null
89
+ AudienceIds : ["7aa4a1ca-4035-4f2f-bac7-7beada59b5ba"]
75
90
  CurrentLCID : 1033
76
91
  Id : 2031
77
92
  IsDocLib : true
@@ -86,5 +101,5 @@ m365 spo navigation node add --webUrl https://contoso.sharepoint.com/sites/team-
86
101
 
87
102
  ```csv
88
103
  AudienceIds,CurrentLCID,Id,IsDocLib,IsExternal,IsVisible,ListTemplateType,Title,Url
89
- ,1033,2032,1,1,1,0,Navigation Link,https://contoso.sharepoint.com
104
+ "[""7aa4a1ca-4035-4f2f-bac7-7beada59b5ba""]",1033,2032,1,1,1,0,Navigation Link,https://contoso.sharepoint.com
90
105
  ```
@@ -0,0 +1,91 @@
1
+ # spo navigation node get
2
+
3
+ Gets information about a specific navigation node.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo navigation node get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site.
15
+
16
+ `--id <id>`
17
+ : Id of the navigation node.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve information for a specific navigation node.
24
+
25
+ ```sh
26
+ m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209
27
+ ```
28
+
29
+ ## Response
30
+
31
+ === "JSON"
32
+
33
+ ```json
34
+ {
35
+ "AudienceIds": [
36
+ "0d718612-8407-4d6b-833c-6891a553354f",
37
+ "f864446f-b4d7-475a-a2ba-1080c6474020"
38
+ ],
39
+ "CurrentLCID": 1033,
40
+ "Id": 2209,
41
+ "IsDocLib": true,
42
+ "IsExternal": false,
43
+ "IsVisible": true,
44
+ "ListTemplateType": 100,
45
+ "Title": "Work Status",
46
+ "Url": "/sites/team-a/Lists/Work Status/AllItems.aspx"
47
+ }
48
+ ```
49
+
50
+ === "Text"
51
+
52
+ ```text
53
+ AudienceIds : ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
54
+ CurrentLCID : 1033
55
+ Id : 2209
56
+ IsDocLib : true
57
+ IsExternal : false
58
+ IsVisible : true
59
+ ListTemplateType: 100
60
+ Title : Work Status
61
+ Url : /sites/team-a/Lists/Work Status/AllItems.aspx
62
+ ```
63
+
64
+ === "CSV"
65
+
66
+ ```csv
67
+ AudienceIds,CurrentLCID,Id,IsDocLib,IsExternal,IsVisible,ListTemplateType,Title,Url
68
+ [""0d718612-8407-4d6b-833c-6891a553354f"", ""f864446f-b4d7-475a-a2ba-1080c6474020""],1033,2209,1,,1,100,Work Status,/sites/team-a/Lists/Work Status/AllItems.aspx
69
+ ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ # spo navigation node get --webUrl "https://contoso.sharepoint.com/sites/team-a" --id "2209"
75
+
76
+ Date: 1/29/2023
77
+
78
+ ## Work Status (2209)
79
+
80
+ Property | Value
81
+ ---------|-------
82
+ AudienceIds | ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
83
+ CurrentLCID | 1033
84
+ Id | 2209
85
+ IsDocLib | true
86
+ IsExternal | false
87
+ IsVisible | true
88
+ ListTemplateType | 100
89
+ Title | Work Status
90
+ Url | /sites/team-a/Lists/Work Status/AllItems.aspx
91
+ ```
@@ -39,7 +39,15 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team
39
39
  ```json
40
40
  [
41
41
  {
42
+ "AudienceIds": [
43
+ "5786b8e8-c495-4734-b345-756733960730"
44
+ ],
45
+ "CurrentLCID": 1033,
42
46
  "Id": 2032,
47
+ "IsDocLib": true,
48
+ "IsExternal": true,
49
+ "IsVisible": true,
50
+ "ListTemplateType": 0,
43
51
  "Title": "Navigation Link",
44
52
  "Url": "https://contoso.sharepoint.com"
45
53
  }
@@ -60,3 +68,25 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team
60
68
  Id,Title,Url
61
69
  2032,Navigation Link,https://contoso.sharepoint.com
62
70
  ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # spo navigation node list --webUrl "https://contoso.sharepoint.com" --location "QuickLaunch"
76
+
77
+ Date: 27/1/2023
78
+
79
+ ## Home (1031)
80
+
81
+ Property | Value
82
+ ---------|-------
83
+ AudienceIds | ["5786b8e8-c495-4734-b345-756733960730"]
84
+ CurrentLCID | 1033
85
+ Id | 2032
86
+ IsDocLib | true
87
+ IsExternal | false
88
+ IsVisible | true
89
+ ListTemplateType | 0
90
+ Title | Navigation Link
91
+ Url | https://contoso.sharepoint.com
92
+ ```
@@ -14,7 +14,7 @@ m365 spo navigation node remove [options]
14
14
  : Absolute URL of the site to which navigation should be modified
15
15
 
16
16
  `-l, --location <location>`
17
- : Navigation type where the node should be added. Available options: `QuickLaunch,TopNavigationBar`
17
+ : Navigation type where the node should be removed. Available options: `QuickLaunch,TopNavigationBar`
18
18
 
19
19
  `-i, --id <id>`
20
20
  : ID of the node to remove
@@ -0,0 +1,59 @@
1
+ # spo navigation node set
2
+
3
+ Updates a SharePoint navigation node
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo navigation node set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site.
15
+
16
+ `--id <id>`
17
+ : Id of the navigation node.
18
+
19
+ `--title [title]`
20
+ : New title of the navigation node.
21
+
22
+ `--url [url]`
23
+ : New URL of the navigation node.
24
+
25
+ `--audienceIds [audienceIds]`
26
+ : Comma separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
27
+
28
+ `--isExternal [isExternal]`
29
+ : Whether the navigation node points to an external URL. Valid values: `true` or `false`.
30
+
31
+ --8<-- "docs/cmd/_global.md"
32
+
33
+ ## Remarks
34
+
35
+ To enable/disable audience targeting for the navigation bar, use the [`spo web set`](../web/web-set.md) command.
36
+
37
+ ## Examples
38
+
39
+ Updates the title of a navigation node
40
+
41
+ ```sh
42
+ m365 spo navigation node set --webUrl https://contoso.sharepoint.com/sites/marketing --id 2209 --title "Pictures"
43
+ ```
44
+
45
+ Updates the URL of a navigation node
46
+
47
+ ```sh
48
+ m365 spo navigation node set --webUrl https://contoso.sharepoint.com/sites/marketing --id 2209 --url "https://www.microsoft.com" --isExternal true
49
+ ```
50
+
51
+ Updates audience targeting of a navigation node with 3 groups
52
+
53
+ ```sh
54
+ m365 spo navigation node set --webUrl https://contoso.sharepoint.com/sites/marketing --id 2209 --audienceIds "61f78c73-f71a-471e-a3b9-15daa936e200,9524e6b4-e663-44fe-b179-210c963e37e7,c42b8756-494d-4141-a575-45f01320e26a"
55
+ ```
56
+
57
+ ## Response
58
+
59
+ The command won't return a response on success.
@@ -28,6 +28,9 @@ m365 spo sitedesign add [options]
28
28
  `-a, --previewImageAltText [previewImageAltText]`
29
29
  : The alt text description of the image for accessibility
30
30
 
31
+ `--thumbnailUrl [thumbnailUrl]`
32
+ : The new URL of a thumbnail image. If none is specified SharePoint will use a generic image
33
+
31
34
  `--isDefault`
32
35
  : Set if the site design is applied as the default site design
33
36