@pnp/cli-microsoft365 12.0.0-beta.c9bd7f3 → 12.0.0-beta.d58fb77

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 (179) hide show
  1. package/.devproxy/generate-openapi-spec.json +1 -1
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +15 -1
  5. package/dist/googleAnalytics.js +96 -0
  6. package/dist/m365/cli/commands/cli-consent.js +9 -2
  7. package/dist/m365/entra/commands/m365group/m365group-remove.js +2 -8
  8. package/dist/m365/spfx/commands/SpfxCompatibilityMatrix.js +15 -0
  9. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.24.0.js +19 -0
  10. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  11. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN012021_TSC_excludeDirectories.js +43 -0
  12. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027002_OVERRIDES_qs.js +33 -0
  13. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027003_OVERRIDES_uuid.js +33 -0
  14. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.24.0.js +77 -0
  15. package/dist/m365/spfx/commands/project/project-upgrade.js +2 -1
  16. package/dist/m365/spo/commands/app/app-add.js +35 -56
  17. package/dist/m365/spo/commands/app/app-deploy.js +41 -59
  18. package/dist/m365/spo/commands/app/app-get.js +40 -56
  19. package/dist/m365/spo/commands/app/app-install.js +20 -41
  20. package/dist/m365/spo/commands/app/app-instance-list.js +12 -24
  21. package/dist/m365/spo/commands/app/app-list.js +26 -44
  22. package/dist/m365/spo/commands/app/app-remove.js +32 -52
  23. package/dist/m365/spo/commands/app/app-retract.js +32 -51
  24. package/dist/m365/spo/commands/app/app-teamspackage-download.js +35 -54
  25. package/dist/m365/spo/commands/app/app-uninstall.js +21 -44
  26. package/dist/m365/spo/commands/app/app-upgrade.js +20 -41
  27. package/dist/m365/spo/commands/commandset/commandset-add.js +17 -59
  28. package/dist/m365/spo/commands/commandset/commandset-get.js +24 -62
  29. package/dist/m365/spo/commands/commandset/commandset-list.js +11 -34
  30. package/dist/m365/spo/commands/commandset/commandset-remove.js +21 -54
  31. package/dist/m365/spo/commands/commandset/commandset-set.js +30 -83
  32. package/dist/m365/spo/commands/feature/feature-disable.js +20 -50
  33. package/dist/m365/spo/commands/feature/feature-enable.js +22 -50
  34. package/dist/m365/spo/commands/feature/feature-list.js +11 -36
  35. package/dist/m365/spo/commands/field/field-add.js +33 -62
  36. package/dist/m365/spo/commands/field/field-get.js +30 -57
  37. package/dist/m365/spo/commands/field/field-list.js +21 -46
  38. package/dist/m365/spo/commands/field/field-remove.js +32 -63
  39. package/dist/m365/spo/commands/field/field-set.js +34 -66
  40. package/dist/m365/spo/commands/file/file-get.js +4 -3
  41. package/dist/m365/spo/commands/folder/folder-unarchive.js +90 -0
  42. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +38 -63
  43. package/dist/m365/spo/commands/hubsite/hubsite-data-get.js +11 -27
  44. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +25 -47
  45. package/dist/m365/spo/commands/hubsite/hubsite-get.js +25 -37
  46. package/dist/m365/spo/commands/hubsite/hubsite-list.js +12 -24
  47. package/dist/m365/spo/commands/hubsite/hubsite-register.js +10 -18
  48. package/dist/m365/spo/commands/hubsite/hubsite-rights-grant.js +14 -32
  49. package/dist/m365/spo/commands/hubsite/hubsite-rights-revoke.js +12 -29
  50. package/dist/m365/spo/commands/hubsite/hubsite-set.js +19 -46
  51. package/dist/m365/spo/commands/hubsite/hubsite-unregister.js +11 -27
  52. package/dist/m365/spo/commands/listitem/listitem-get.js +1 -12
  53. package/dist/m365/spo/commands/navigation/navigation-node-add.js +74 -120
  54. package/dist/m365/spo/commands/navigation/navigation-node-get.js +4 -13
  55. package/dist/m365/spo/commands/navigation/navigation-node-list.js +6 -4
  56. package/dist/m365/spo/commands/navigation/navigation-node-set.js +53 -114
  57. package/dist/m365/spo/commands/page/page-unpublish.js +53 -0
  58. package/dist/m365/spo/commands/site/site-remove.js +3 -9
  59. package/dist/m365/spo/commands/sitescript/sitescript-add.js +22 -37
  60. package/dist/m365/spo/commands/sitescript/sitescript-get.js +9 -26
  61. package/dist/m365/spo/commands/sitescript/sitescript-list.js +5 -0
  62. package/dist/m365/spo/commands/sitescript/sitescript-remove.js +9 -33
  63. package/dist/m365/spo/commands/sitescript/sitescript-set.js +29 -56
  64. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +1 -1
  65. package/dist/m365/spo/commands/web/web-rule-get.js +47 -0
  66. package/dist/m365/spo/commands/web/web-rule-list.js +113 -0
  67. package/dist/m365/spo/commands/web/web-rule-remove.js +54 -0
  68. package/dist/m365/spo/commands.js +6 -1
  69. package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +5 -0
  70. package/dist/m365/spp/commands/model/model-get.js +25 -45
  71. package/dist/m365/spp/commands/model/model-list.js +12 -23
  72. package/dist/m365/spp/commands/model/model-remove.js +25 -45
  73. package/dist/m365/teams/commands/channel/channel-add.js +46 -57
  74. package/dist/m365/teams/commands/channel/channel-get.js +41 -48
  75. package/dist/m365/teams/commands/channel/channel-list.js +28 -42
  76. package/dist/m365/teams/commands/channel/channel-member-add.js +53 -54
  77. package/dist/m365/teams/commands/channel/channel-member-list.js +47 -55
  78. package/dist/m365/teams/commands/channel/channel-member-remove.js +62 -62
  79. package/dist/m365/teams/commands/channel/channel-member-set.js +61 -65
  80. package/dist/m365/teams/commands/channel/channel-remove.js +47 -49
  81. package/dist/m365/teams/commands/channel/channel-set.js +47 -54
  82. package/dist/m365/teams/commands/chat/chat-get.js +30 -45
  83. package/dist/m365/teams/commands/chat/chat-list.js +22 -42
  84. package/dist/m365/teams/commands/chat/chat-member-add.js +43 -64
  85. package/dist/m365/teams/commands/chat/chat-member-list.js +10 -23
  86. package/dist/m365/teams/commands/chat/chat-member-remove.js +28 -50
  87. package/dist/m365/teams/commands/chat/chat-message-send.js +32 -55
  88. package/dist/m365/teams/commands/meeting/meeting-add.js +57 -68
  89. package/dist/m365/teams/commands/meeting/meeting-attendancereport-get.js +33 -58
  90. package/dist/m365/teams/commands/meeting/meeting-attendancereport-list.js +14 -38
  91. package/dist/m365/teams/commands/meeting/meeting-get.js +14 -38
  92. package/dist/m365/teams/commands/meeting/meeting-list.js +34 -59
  93. package/dist/m365/teams/commands/meeting/meeting-transcript-get.js +34 -58
  94. package/dist/m365/teams/commands/meeting/meeting-transcript-list.js +29 -50
  95. package/dist/m365/teams/commands/message/message-get.js +19 -30
  96. package/dist/m365/teams/commands/message/message-list.js +26 -43
  97. package/dist/m365/teams/commands/message/message-remove.js +43 -58
  98. package/dist/m365/teams/commands/message/message-reply-list.js +19 -30
  99. package/dist/m365/teams/commands/message/message-restore.js +40 -50
  100. package/dist/m365/teams/commands/message/message-send.js +19 -30
  101. package/dist/m365/util/commands/accesstoken/accesstoken-get.js +10 -28
  102. package/dist/telemetry.js +7 -11
  103. package/dist/utils/spo.js +40 -3
  104. package/dist/utils/urlUtil.js +2 -2
  105. package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +0 -3
  106. package/docs/docs/cmd/login.mdx +15 -2
  107. package/docs/docs/cmd/spfx/project/project-upgrade.mdx +1 -1
  108. package/docs/docs/cmd/spo/file/file-archive.mdx +1 -1
  109. package/docs/docs/cmd/spo/file/file-checkin.mdx +2 -2
  110. package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -1
  111. package/docs/docs/cmd/spo/file/file-checkout.mdx +2 -2
  112. package/docs/docs/cmd/spo/file/file-copy.mdx +2 -2
  113. package/docs/docs/cmd/spo/file/file-get.mdx +6 -6
  114. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  115. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +1 -1
  116. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
  117. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  118. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +3 -3
  119. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +2 -2
  120. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +2 -2
  121. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +22 -1
  122. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +24 -1
  123. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +22 -1
  124. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +22 -1
  125. package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +24 -1
  126. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +22 -1
  127. package/docs/docs/cmd/spo/file/file-unarchive.mdx +1 -1
  128. package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
  129. package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
  130. package/docs/docs/cmd/spo/file/file-version-keep.mdx +1 -1
  131. package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
  132. package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
  133. package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
  134. package/docs/docs/cmd/spo/folder/folder-archive.mdx +1 -1
  135. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  136. package/docs/docs/cmd/spo/folder/folder-get.mdx +2 -2
  137. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
  138. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
  139. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +22 -1
  140. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +23 -0
  141. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +21 -0
  142. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +22 -1
  143. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +24 -1
  144. package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx +21 -0
  145. package/docs/docs/cmd/spo/folder/folder-unarchive.mdx +76 -0
  146. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -6
  147. package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +45 -30
  148. package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +64 -42
  149. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +37 -27
  150. package/docs/docs/cmd/spo/navigation/navigation-node-set.mdx +10 -8
  151. package/docs/docs/cmd/spo/page/page-unpublish.mdx +63 -0
  152. package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
  153. package/docs/docs/cmd/spo/web/web-rule-get.mdx +108 -0
  154. package/docs/docs/cmd/spo/web/web-rule-list.mdx +189 -0
  155. package/docs/docs/cmd/spo/web/web-rule-remove.mdx +65 -0
  156. package/docs/docs/cmd/spp/model/model-get.mdx +1 -1
  157. package/docs/docs/cmd/spp/model/model-remove.mdx +1 -1
  158. package/docs/docs/cmd/teams/tab/tab-add.mdx +19 -0
  159. package/docs/docs/cmd/teams/tab/tab-get.mdx +19 -0
  160. package/docs/docs/cmd/teams/tab/tab-list.mdx +19 -0
  161. package/docs/docs/cmd/teams/tab/tab-remove.mdx +21 -0
  162. package/docs/docs/cmd/tenant/people/people-profilecardproperty-add.mdx +19 -0
  163. package/docs/docs/cmd/tenant/people/people-profilecardproperty-get.mdx +19 -0
  164. package/docs/docs/cmd/tenant/people/people-profilecardproperty-list.mdx +19 -0
  165. package/docs/docs/cmd/tenant/people/people-profilecardproperty-remove.mdx +19 -0
  166. package/docs/docs/cmd/tenant/people/people-profilecardproperty-set.mdx +19 -0
  167. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.mdx +19 -0
  168. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.mdx +19 -0
  169. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.mdx +19 -0
  170. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.mdx +19 -0
  171. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.mdx +19 -0
  172. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.mdx +19 -0
  173. package/docs/docs/cmd/viva/engage/engage-message-add.mdx +17 -0
  174. package/docs/docs/cmd/viva/engage/engage-message-get.mdx +17 -0
  175. package/docs/docs/cmd/viva/engage/engage-message-list.mdx +17 -0
  176. package/docs/docs/cmd/viva/engage/engage-message-remove.mdx +19 -0
  177. package/npm-shrinkwrap.json +702 -3230
  178. package/package.json +21 -38
  179. package/dist/appInsights.js +0 -43
package/dist/utils/spo.js CHANGED
@@ -576,6 +576,45 @@ export const spo = {
576
576
  return request.post(requestOptions);
577
577
  },
578
578
  /**
579
+ * Retrieves the navigation node with the specified key.
580
+ * Returns the node along with the menu state that contains it.
581
+ * @param webUrl Web url
582
+ * @param key Key (ID) of the navigation node
583
+ * @param location Navigation to search. When not specified, searches the quick launch first and then the top navigation
584
+ */
585
+ async getMenuStateNodeByKey(webUrl, key, location) {
586
+ const locations = location ? [location] : ['QuickLaunch', 'TopNavigationBar'];
587
+ for (const navigationLocation of locations) {
588
+ const menuState = navigationLocation === 'TopNavigationBar'
589
+ ? await this.getTopNavigationMenuState(webUrl)
590
+ : await this.getQuickLaunchMenuState(webUrl);
591
+ const node = this.findMenuStateNode(menuState.Nodes, key);
592
+ if (node) {
593
+ return { menuState, node };
594
+ }
595
+ }
596
+ throw location
597
+ ? `Navigation node with id '${key}' not found in ${location}.`
598
+ : `Navigation node with id '${key}' not found.`;
599
+ },
600
+ /**
601
+ * Recursively searches the specified menu state nodes for the node with the specified key.
602
+ * @param nodes Menu state nodes to search
603
+ * @param key Key (ID) of the navigation node
604
+ */
605
+ findMenuStateNode(nodes, key) {
606
+ for (const node of nodes) {
607
+ if (node.Key === key) {
608
+ return node;
609
+ }
610
+ const childNode = this.findMenuStateNode(node.Nodes, key);
611
+ if (childNode) {
612
+ return childNode;
613
+ }
614
+ }
615
+ return undefined;
616
+ },
617
+ /**
579
618
  * Retrieves the spo group by name.
580
619
  * Returns a group object
581
620
  * @param webUrl Web url
@@ -1250,9 +1289,7 @@ export const spo = {
1250
1289
  // Neither properties nor contentTypeName provided, no need to proceed
1251
1290
  throw 'Either properties or contentTypeName must be provided for systemUpdateListItem.';
1252
1291
  }
1253
- const parsedUrl = new URL(absoluteListUrl);
1254
- const serverRelativeSiteMatch = absoluteListUrl.match(new RegExp('/sites/[^/]+'));
1255
- const webUrl = `${parsedUrl.protocol}//${parsedUrl.host}${serverRelativeSiteMatch ?? ''}`;
1292
+ const webUrl = absoluteListUrl.substring(0, absoluteListUrl.indexOf('/_api/'));
1256
1293
  if (verbose && logger) {
1257
1294
  await logger.logToStderr(`Getting list id...`);
1258
1295
  }
@@ -165,8 +165,8 @@ export const urlUtil = {
165
165
  */
166
166
  getTargetSiteAbsoluteUrl(webUrl, url) {
167
167
  const fullUrl = url.startsWith('https://') ? url : urlUtil.getAbsoluteUrl(webUrl, url);
168
- // Pattern to match SharePoint URLs
169
- const urlPattern = /https:\/\/[\w-]+\.sharepoint\.com\/(teams|sites|personal)\/([\w-]+)/;
168
+ // Pattern to match SharePoint site collection URLs on any of the supported managed paths
169
+ const urlPattern = /^https:\/\/[\w-]+\.sharepoint\.com\/(teams|sites|personal)\/[^/?#]+/i;
170
170
  const match = fullUrl.match(urlPattern);
171
171
  if (match) {
172
172
  // If a match is found, return the matched URL
@@ -26,9 +26,6 @@ m365 entra m365group remove [options]
26
26
 
27
27
  `--permanent`
28
28
  : Permanently remove the group without leaving it in the recycle bin.
29
-
30
- `--skipRecycleBin`
31
- : Deprecated: use `--permanent` instead.
32
29
  ```
33
30
 
34
31
  <Global />
@@ -78,7 +78,20 @@ When logging in to Microsoft 365 using the user name and password, next to the a
78
78
 
79
79
  When logging in to Microsoft 365 using a certificate, the CLI for Microsoft 365 will store the contents of the certificate so that it can automatically re-authenticate if necessary. The contents of the certificate are removed by re-authenticating using the device code or by calling the [logout](logout.mdx) command.
80
80
 
81
- Federated Identity is currently supported in GitHub Actions. To use this you need to set `authType` to `federatedIdentity` and specify `appId` and `tenant` to the values of the app registration you've configured a federated credential on.
81
+ Federated Identity is currently supported in GitHub Actions, Azure DevOps and GitLab CI/CD. To use this you need to set `authType` to `federatedIdentity` and specify `appId` and `tenant` to the values of the app registration you've configured a federated credential on.
82
+
83
+ To use Federated Identity in GitLab CI/CD, the job must request an ID token named `GITLAB_OIDC_TOKEN` with audience `api://AzureADTokenExchange`, for example:
84
+
85
+ ```yaml
86
+ job:
87
+ id_tokens:
88
+ GITLAB_OIDC_TOKEN:
89
+ aud: "api://AzureADTokenExchange"
90
+ script:
91
+ - m365 login --authType federatedIdentity --appId eb96cfd0-abfa-4477-8d1d-c6dfde3efb19 --tenant 9a1a1bbd-e158-4cf5-967d-a53b8e85c628
92
+ ```
93
+
94
+ The corresponding federated credential on the Microsoft Entra app registration must have issuer `https://gitlab.com` (or your self-managed GitLab instance URL) and a subject matching the GitLab OIDC claim for the job, for example `project_path:<group>/<project>:ref_type:branch:ref:<branch>`.
82
95
 
83
96
  To log in to Microsoft 365 using a certificate or secret, you will typically [create a custom Microsoft Entra application](../user-guide/using-own-identity.mdx). To use this application with the CLI for Microsoft 365, you will set the `CLIMICROSOFT365_ENTRAAPPID` environment variable to the application's ID and the `CLIMICROSOFT365_TENANT` environment variable to the ID of the Microsoft Entra tenant, where you created the Microsoft Entra application. Also, please make sure to read about [the caveats when using the certificate login option](../user-guide/cli-certificate-caveats.mdx).
84
97
 
@@ -202,7 +215,7 @@ Log in to Microsoft 365 using a user-assigned managed identity with `clientId` s
202
215
  m365 login --authType identity --userName ac9fbed5-804c-4362-a369-21a4ec51109e
203
216
  ```
204
217
 
205
- Log in to Microsoft 365 using a federated identity. Can currently only be used in GitHub Actions.
218
+ Log in to Microsoft 365 using a federated identity. Can currently only be used in GitHub Actions, Azure DevOps and GitLab CI/CD.
206
219
 
207
220
  ```sh
208
221
  m365 login --authType federatedIdentity --appId eb96cfd0-abfa-4477-8d1d-c6dfde3efb19 --tenant 9a1a1bbd-e158-4cf5-967d-a53b8e85c628
@@ -45,7 +45,7 @@ m365 spfx project upgrade [options]
45
45
 
46
46
  ## Remarks
47
47
 
48
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.23.2).
48
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.24.0).
49
49
 
50
50
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
51
51
 
@@ -22,7 +22,7 @@ m365 spo file archive [options]
22
22
  : The server- or site-relative decoded URL of the file to archive. Specify either `url` or `id`, but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to archive. Specify either `url` or `id`, but not both.
25
+ : The unique ID (GUID) of the file to archive. Specify either `url` or `id`, but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -22,7 +22,7 @@ m365 spo file checkin [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
 
27
27
  `-t, --type [type]`
28
28
  : Type of the check in. Allowed values: `Minor`, `Major`, `Overwrite`. Defaults to `Major`.
@@ -54,7 +54,7 @@ m365 spo file checkin [options]
54
54
 
55
55
  ## Examples
56
56
 
57
- Checks in file with the specified UniqueId located in the specified site.
57
+ Checks in file with the specified unique ID located in the specified site.
58
58
 
59
59
  ```sh
60
60
  m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
@@ -22,7 +22,7 @@ m365 spo file checkout undo [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -22,7 +22,7 @@ m365 spo file checkout [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -48,7 +48,7 @@ m365 spo file checkout [options]
48
48
 
49
49
  ## Examples
50
50
 
51
- Checks out file with the specified UniqueId located in the specified site.
51
+ Checks out file with the specified unique ID located in the specified site.
52
52
 
53
53
  ```sh
54
54
  m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
@@ -85,13 +85,13 @@ Copy a file by site-relative URL to a document library in another site collectio
85
85
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
86
86
  ```
87
87
 
88
- Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file (without specifying the file extension).
88
+ Copy file by sourceId (unique ID) to a document library in another site collection and rename the file (without specifying the file extension).
89
89
 
90
90
  ```sh
91
91
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
92
92
  ```
93
93
 
94
- Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
94
+ Copy file by sourceId (unique ID) to a document library in another site collection with a new name, rename the file if it already exists.
95
95
 
96
96
  ```sh
97
97
  m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf" --nameConflictBehavior rename
@@ -22,7 +22,7 @@ m365 spo file get [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `url` or `id` but not both.
26
26
 
27
27
  `--asString`
28
28
  : Set to retrieve the contents of the specified file as string.
@@ -63,25 +63,25 @@ m365 spo file get [options]
63
63
 
64
64
  ## Examples
65
65
 
66
- Get file properties for a file with id (UniqueId) parameter located in a site.
66
+ Get file properties for a file with id (unique ID) parameter located in a site.
67
67
 
68
68
  ```sh
69
69
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
70
70
  ```
71
71
 
72
- Get contents of the file with id (UniqueId) parameter located in a site.
72
+ Get contents of the file with id (unique ID) parameter located in a site.
73
73
 
74
74
  ```sh
75
75
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString
76
76
  ```
77
77
 
78
- Get list item properties for a file with id (UniqueId) parameter located in a site.
78
+ Get list item properties for a file with id (unique ID) parameter located in a site.
79
79
 
80
80
  ```sh
81
81
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem
82
82
  ```
83
83
 
84
- Saves the file with id (UniqueId) parameter located in a site to a local file.
84
+ Saves the file with id (unique ID) parameter located in a site to a local file.
85
85
 
86
86
  ```sh
87
87
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx
@@ -111,7 +111,7 @@ Saves a file with the server-relative url located in a site to a local file.
111
111
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx
112
112
  ```
113
113
 
114
- Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions.
114
+ Gets the file properties for a file with id (unique ID) parameter located in a site with permissions.
115
115
 
116
116
  ```sh
117
117
  m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions
@@ -22,7 +22,7 @@ m365 spo file retentionlabel ensure [options]
22
22
  : The site- or server-relative decoded URL of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file that should be labelled. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--name <name>`
28
28
  : Name of the retention label to apply to the file.
@@ -22,7 +22,7 @@ m365 spo file retentionlabel remove [options]
22
22
  : The server- or site-relative decoded URL of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file of which the label should be removed. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirming removing the retention label from a file.
@@ -22,7 +22,7 @@ m365 spo file roleassignment add [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--principalId [principalId]`
28
28
  : The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either `upn`, `groupName`, or `principalId` but not multiple.
@@ -22,7 +22,7 @@ m365 spo file roleassignment remove [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--principalId [principalId]`
28
28
  : The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, `entraGroupId`, `entraGroupName`, or `principalId` but not multiple.
@@ -22,7 +22,7 @@ m365 spo file roleinheritance break [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-c, --clearExistingPermissions`
28
28
  : Clear all existing permissions from the file.
@@ -54,13 +54,13 @@ m365 spo file roleinheritance break [options]
54
54
 
55
55
  ## Examples
56
56
 
57
- Break the inheritance of a file with a specific id (UniqueId).
57
+ Break the inheritance of a file with a specific id (unique ID).
58
58
 
59
59
  ```sh
60
60
  m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
61
61
  ```
62
62
 
63
- Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
63
+ Break the inheritance of a file with a specific id (unique ID) and clear all existing permissions.
64
64
 
65
65
  ```sh
66
66
  m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
@@ -22,7 +22,7 @@ m365 spo file roleinheritance reset [options]
22
22
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -51,7 +51,7 @@ m365 spo file roleinheritance reset [options]
51
51
 
52
52
  ## Examples
53
53
 
54
- Reset inheritance of file with the specified id (UniqueId) located in the specified site.
54
+ Reset inheritance of file with the specified id (unique ID) located in the specified site.
55
55
 
56
56
  ```sh
57
57
  m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
@@ -22,7 +22,7 @@ m365 spo file sharinginfo get [options]
22
22
  : The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -54,7 +54,7 @@ Get file sharing information report for the file with the specified server-relat
54
54
  m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl "/sites/M365CLI/Shared Documents/SharedFile.docx"
55
55
  ```
56
56
 
57
- Get file sharing information report for file with the specified id (UniqueId) located in the specified site.
57
+ Get file sharing information report for file with the specified id (unique ID) located in the specified site.
58
58
 
59
59
  ```sh
60
60
  m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
@@ -22,7 +22,7 @@ m365 spo file sharinglink add [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--type <type>`
28
28
  : The type of sharing link to create. Either `view` or `edit`.
@@ -36,6 +36,27 @@ m365 spo file sharinglink add [options]
36
36
 
37
37
  <Global />
38
38
 
39
+ ## Permissions
40
+
41
+ <Tabs>
42
+ <TabItem value="Delegated">
43
+
44
+ | Resource | Permissions |
45
+ |-----------------|-----------------|
46
+ | Microsoft Graph | Files.ReadWrite |
47
+ | SharePoint | AllSites.Read |
48
+
49
+ </TabItem>
50
+ <TabItem value="Application">
51
+
52
+ | Resource | Permissions |
53
+ |-----------------|---------------------|
54
+ | Microsoft Graph | Files.ReadWrite.All |
55
+ | SharePoint | Sites.Read.All |
56
+
57
+ </TabItem>
58
+ </Tabs>
59
+
39
60
  ## Examples
40
61
 
41
62
  Creates a sharing link of a specific type for a file by id.
@@ -1,4 +1,6 @@
1
1
  import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo file sharinglink clear
4
6
 
@@ -20,7 +22,7 @@ m365 spo file sharinglink clear [options]
20
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
21
23
 
22
24
  `--fileId [fileId]`
23
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
24
26
 
25
27
  `-s, --scope [scope]`
26
28
  : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
@@ -31,6 +33,27 @@ m365 spo file sharinglink clear [options]
31
33
 
32
34
  <Global />
33
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|-----------------|
43
+ | Microsoft Graph | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
34
57
  ## Examples
35
58
 
36
59
  Removes all sharing links from a file specified by id without prompting for confirmation.
@@ -22,7 +22,7 @@ m365 spo file sharinglink get [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --id <id>`
28
28
  : The ID of the sharing link.
@@ -30,6 +30,27 @@ m365 spo file sharinglink get [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Permissions
34
+
35
+ <Tabs>
36
+ <TabItem value="Delegated">
37
+
38
+ | Resource | Permissions |
39
+ |-----------------|---------------|
40
+ | Microsoft Graph | Files.Read |
41
+ | SharePoint | AllSites.Read |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|----------------|
48
+ | Microsoft Graph | Files.Read.All |
49
+ | SharePoint | Sites.Read.All |
50
+
51
+ </TabItem>
52
+ </Tabs>
53
+
33
54
  ## Examples
34
55
 
35
56
  Gets a specific sharing link of a file by id.
@@ -22,7 +22,7 @@ m365 spo file sharinglink list [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-s, --scope [scope]`
28
28
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
@@ -30,6 +30,27 @@ m365 spo file sharinglink list [options]
30
30
 
31
31
  <Global />
32
32
 
33
+ ## Permissions
34
+
35
+ <Tabs>
36
+ <TabItem value="Delegated">
37
+
38
+ | Resource | Permissions |
39
+ |-----------------|---------------|
40
+ | Microsoft Graph | Files.Read |
41
+ | SharePoint | AllSites.Read |
42
+
43
+ </TabItem>
44
+ <TabItem value="Application">
45
+
46
+ | Resource | Permissions |
47
+ |-----------------|----------------|
48
+ | Microsoft Graph | Files.Read.All |
49
+ | SharePoint | Sites.Read.All |
50
+
51
+ </TabItem>
52
+ </Tabs>
53
+
33
54
  ## Examples
34
55
 
35
56
  List sharing links of a file by id.
@@ -1,4 +1,6 @@
1
1
  import Global from '../../_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
2
4
 
3
5
  # spo file sharinglink remove
4
6
 
@@ -20,7 +22,7 @@ m365 spo file sharinglink remove [options]
20
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
21
23
 
22
24
  `--fileId [fileId]`
23
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
24
26
 
25
27
  `-i, --id <id>`
26
28
  : The ID of the sharing link.
@@ -31,6 +33,27 @@ m365 spo file sharinglink remove [options]
31
33
 
32
34
  <Global />
33
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|-----------------|
43
+ | Microsoft Graph | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
34
57
  ## Examples
35
58
 
36
59
  Removes a specific sharing link from a file by id without prompting for confirmation.
@@ -22,7 +22,7 @@ m365 spo file sharinglink set [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `--fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--id <id>`
28
28
  : The ID of the sharing link.
@@ -33,6 +33,27 @@ m365 spo file sharinglink set [options]
33
33
 
34
34
  <Global />
35
35
 
36
+ ## Permissions
37
+
38
+ <Tabs>
39
+ <TabItem value="Delegated">
40
+
41
+ | Resource | Permissions |
42
+ |-----------------|-----------------|
43
+ | Microsoft Graph | Files.ReadWrite |
44
+ | SharePoint | AllSites.Read |
45
+
46
+ </TabItem>
47
+ <TabItem value="Application">
48
+
49
+ | Resource | Permissions |
50
+ |-----------------|---------------------|
51
+ | Microsoft Graph | Files.ReadWrite.All |
52
+ | SharePoint | Sites.Read.All |
53
+
54
+ </TabItem>
55
+ </Tabs>
56
+
36
57
  ## Examples
37
58
 
38
59
  Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter.
@@ -22,7 +22,7 @@ m365 spo file unarchive [options]
22
22
  : The server- or site-relative decoded URL of the file to unarchive. Specify either `url` or `id`, but not both.
23
23
 
24
24
  `-i, --id [id]`
25
- : The UniqueId (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
25
+ : The unique ID (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -22,7 +22,7 @@ m365 spo file version clear [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-f, --force`
28
28
  : Don't prompt for confirmation.
@@ -25,7 +25,7 @@ m365 spo file version get [options]
25
25
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --fileId [fileId]`
28
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
28
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
29
29
  ```
30
30
 
31
31
  <Global />
@@ -22,7 +22,7 @@ m365 spo file version keep [options]
22
22
  : The server- or site-relative decoded URL. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `--label <label>`
28
28
  : Label of the version.
@@ -22,7 +22,7 @@ m365 spo file version list [options]
22
22
  : The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.
23
23
 
24
24
  `-i, --fileId [fileId]`
25
- : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
25
+ : The unique ID (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -25,7 +25,7 @@ m365 spo file version remove [options]
25
25
  : The server- or site-relative decoded URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
26
26
 
27
27
  `-i, --fileId [fileId]`
28
- : The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
28
+ : The unique ID (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both.
29
29
 
30
30
  `-f, --force`
31
31
  : Don't prompt for confirmation.