@pnp/cli-microsoft365 9.1.0-beta.9a7d76f → 10.0.0-beta.04ac437

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 (134) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +3 -1
  4. package/dist/cli/cli.js +1 -1
  5. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  6. package/dist/m365/cli/commands/cli-consent.js +3 -7
  7. package/dist/m365/cli/commands/config/config-set.js +0 -1
  8. package/dist/m365/commands/setupPresets.js +2 -4
  9. package/dist/m365/commands/status.js +2 -2
  10. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  11. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  12. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  13. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  14. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  15. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  16. package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
  17. package/dist/m365/file/commands/file-move.js +135 -0
  18. package/dist/m365/file/commands.js +2 -1
  19. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  20. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  21. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.20.0-rc.1.js +25 -0
  22. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  23. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
  24. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.20.0-rc.1.js +57 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  26. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  27. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +0 -1
  28. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +8 -8
  29. package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +2 -2
  30. package/dist/m365/spo/commands/file/file-copy.js +59 -34
  31. package/dist/m365/spo/commands/file/file-move.js +55 -33
  32. package/dist/m365/spo/commands/folder/folder-set.js +0 -4
  33. package/dist/m365/spo/commands/list/list-list.js +1 -4
  34. package/dist/m365/spo/commands/site/site-admin-remove.js +193 -0
  35. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
  36. package/dist/m365/spo/commands/site/site-remove.js +1 -7
  37. package/dist/m365/spo/commands/sitescript/sitescript-get.js +3 -2
  38. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
  39. package/dist/m365/spo/commands.js +1 -1
  40. package/dist/m365/teams/MeetingTranscript.js +2 -0
  41. package/dist/m365/teams/commands/meeting/meeting-transcript-get.js +152 -0
  42. package/dist/m365/teams/commands.js +1 -0
  43. package/dist/m365/viva/commands/engage/engage-group-list.js +0 -5
  44. package/dist/m365/viva/commands/engage/engage-group-user-add.js +0 -5
  45. package/dist/m365/viva/commands/engage/engage-group-user-remove.js +0 -5
  46. package/dist/m365/viva/commands/engage/engage-message-add.js +0 -5
  47. package/dist/m365/viva/commands/engage/engage-message-get.js +0 -5
  48. package/dist/m365/viva/commands/engage/engage-message-like-set.js +0 -5
  49. package/dist/m365/viva/commands/engage/engage-message-list.js +0 -5
  50. package/dist/m365/viva/commands/engage/engage-message-remove.js +0 -5
  51. package/dist/m365/viva/commands/engage/engage-network-list.js +0 -5
  52. package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +0 -8
  53. package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +0 -8
  54. package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +0 -8
  55. package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +0 -8
  56. package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +0 -8
  57. package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +0 -8
  58. package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +0 -8
  59. package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +0 -8
  60. package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +0 -8
  61. package/dist/m365/viva/commands/engage/engage-search.js +0 -5
  62. package/dist/m365/viva/commands/engage/engage-user-get.js +0 -5
  63. package/dist/m365/viva/commands/engage/engage-user-list.js +0 -5
  64. package/dist/settingsNames.js +0 -1
  65. package/dist/utils/driveUtil.js +51 -0
  66. package/dist/utils/spo.js +76 -0
  67. package/docs/docs/_clisettings.mdx +0 -1
  68. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  69. package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
  70. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  71. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  72. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  73. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  74. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  75. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  76. package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx +2 -2
  77. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  78. package/docs/docs/cmd/file/file-move.mdx +79 -0
  79. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  80. package/docs/docs/cmd/setup.mdx +1 -3
  81. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
  82. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +6 -5
  83. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +1 -1
  84. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +1 -1
  85. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +1 -1
  86. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +1 -1
  87. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +1 -1
  88. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +1 -1
  89. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +7 -7
  90. package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +2 -2
  91. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +1 -1
  92. package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
  93. package/docs/docs/cmd/spo/file/file-move.mdx +116 -9
  94. package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
  95. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +1 -1
  96. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +1 -1
  97. package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +1 -1
  98. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.mdx +1 -1
  99. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.mdx +1 -1
  100. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.mdx +1 -1
  101. package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
  102. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +1 -1
  103. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx +1 -1
  104. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.mdx +1 -1
  105. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.mdx +1 -1
  106. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.mdx +1 -1
  107. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.mdx +1 -1
  108. package/docs/docs/cmd/spo/site/site-admin-add.mdx +2 -2
  109. package/docs/docs/cmd/spo/site/site-admin-remove.mdx +67 -0
  110. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +1 -1
  111. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +12 -3
  112. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +1 -1
  113. package/docs/docs/cmd/spo/site/site-list.mdx +6 -4
  114. package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
  115. package/docs/docs/cmd/spo/site/site-set.mdx +1 -1
  116. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +14 -1
  117. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +1 -1
  118. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +1 -1
  119. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +1 -1
  120. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +1 -1
  121. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +1 -1
  122. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +1 -1
  123. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
  124. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +1 -1
  125. package/docs/docs/cmd/spo/theme/theme-apply.mdx +1 -1
  126. package/docs/docs/cmd/spo/theme/theme-get.mdx +1 -1
  127. package/docs/docs/cmd/spo/theme/theme-list.mdx +1 -1
  128. package/docs/docs/cmd/spo/theme/theme-remove.mdx +1 -1
  129. package/docs/docs/cmd/spo/theme/theme-set.mdx +1 -1
  130. package/docs/docs/cmd/spp/contentcenter/contentcenter-list.mdx +3 -5
  131. package/docs/docs/cmd/teams/meeting/meeting-transcript-get.mdx +132 -0
  132. package/npm-shrinkwrap.json +2 -2
  133. package/package.json +1 -1
  134. package/dist/m365/viva/commands/engage/yammerCommands.js +0 -25
package/dist/utils/spo.js CHANGED
@@ -12,6 +12,16 @@ import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
12
12
  import { entraGroup } from './entraGroup.js';
13
13
  import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
14
14
  import { setTimeout } from 'timers/promises';
15
+ export var CreateCopyJobsNameConflictBehavior;
16
+ (function (CreateCopyJobsNameConflictBehavior) {
17
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
18
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Replace"] = 1] = "Replace";
19
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
20
+ })(CreateCopyJobsNameConflictBehavior || (CreateCopyJobsNameConflictBehavior = {}));
21
+ // Wrapping this into a settings object so we can alter the values in tests
22
+ export const settings = {
23
+ pollingInterval: 3000
24
+ };
15
25
  export const spo = {
16
26
  async getRequestDigest(siteUrl) {
17
27
  const requestOptions = {
@@ -1540,6 +1550,72 @@ export const spo = {
1540
1550
  const file = await request.get(requestOptions);
1541
1551
  return file;
1542
1552
  },
1553
+ /**
1554
+ * Create a SharePoint copy job to copy a file/folder to another location.
1555
+ * @param webUrl Absolute web URL where the source file/folder is located.
1556
+ * @param sourceUrl Absolute URL of the source file/folder.
1557
+ * @param destinationUrl Absolute URL of the destination folder.
1558
+ * @param options Options for the copy job.
1559
+ * @returns Copy job information. Use {@link spo.getCopyJobResult} to get the result of the copy job.
1560
+ */
1561
+ async createCopyJob(webUrl, sourceUrl, destinationUrl, options) {
1562
+ const requestOptions = {
1563
+ url: `${webUrl}/_api/Site/CreateCopyJobs`,
1564
+ headers: {
1565
+ accept: 'application/json;odata=nometadata'
1566
+ },
1567
+ responseType: 'json',
1568
+ data: {
1569
+ destinationUri: destinationUrl,
1570
+ exportObjectUris: [sourceUrl],
1571
+ options: {
1572
+ NameConflictBehavior: options?.nameConflictBehavior ?? CreateCopyJobsNameConflictBehavior.Fail,
1573
+ AllowSchemaMismatch: true,
1574
+ BypassSharedLock: !!options?.bypassSharedLock,
1575
+ IgnoreVersionHistory: !!options?.ignoreVersionHistory,
1576
+ IncludeItemPermissions: !!options?.includeItemPermissions,
1577
+ CustomizedItemName: options?.newName ? [options.newName] : undefined,
1578
+ SameWebCopyMoveOptimization: true,
1579
+ IsMoveMode: options?.operation === 'move'
1580
+ }
1581
+ }
1582
+ };
1583
+ const response = await request.post(requestOptions);
1584
+ return response.value[0];
1585
+ },
1586
+ /**
1587
+ * Poll until the copy job is finished and return the result.
1588
+ * @param webUrl Absolute web URL where the copy job was created.
1589
+ * @param copyJobInfo Information about the copy job.
1590
+ * @throws Error if the copy job has failed.
1591
+ * @returns Information about the destination object.
1592
+ */
1593
+ async getCopyJobResult(webUrl, copyJobInfo) {
1594
+ const requestOptions = {
1595
+ url: `${webUrl}/_api/Site/GetCopyJobProgress`,
1596
+ headers: {
1597
+ accept: 'application/json;odata=nometadata'
1598
+ },
1599
+ responseType: 'json',
1600
+ data: {
1601
+ copyJobInfo: copyJobInfo
1602
+ }
1603
+ };
1604
+ let progress = await request.post(requestOptions);
1605
+ while (progress.JobState !== 0) {
1606
+ await setTimeout(settings.pollingInterval);
1607
+ progress = await request.post(requestOptions);
1608
+ }
1609
+ const logs = progress.Logs.map(l => JSON.parse(l));
1610
+ // Check if the job has failed
1611
+ const errorLog = logs.find(l => l.Event === 'JobError');
1612
+ if (errorLog) {
1613
+ throw new Error(errorLog.Message);
1614
+ }
1615
+ // Get the destination object information
1616
+ const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
1617
+ return objectInfo;
1618
+ },
1543
1619
  /**
1544
1620
  * Gets the site collection URL for a given web URL using SP Admin site.
1545
1621
  * @param adminUrl The SharePoint admin URL
@@ -22,5 +22,4 @@ Setting name|Definition|Default value
22
22
  `prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`true`
23
23
  `promptListPageSize`|By default, lists of choices longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.|7
24
24
  `showHelpOnFailure`|Automatically display help when executing a command failed|`true`
25
- `showSpinner`|Display spinner when executing commands|`true`
26
25
  `tenantId`|ID of the default tenant to use when authenticating with|``
@@ -16,10 +16,10 @@ m365 app permission add [options]
16
16
  `--appId [appId]`
17
17
  : Client ID of the Microsoft Entra app registered in the .m365rc.json file to retrieve API permissions for.
18
18
 
19
- `--applicationPermission [applicationPermission]`
19
+ `--applicationPermissions [applicationPermissions]`
20
20
  : Space-separated list of application permissions to add.
21
21
 
22
- `--delegatedPermission [delegatedPermission]`
22
+ `--delegatedPermissions [delegatedPermissions]`
23
23
  : Space-separated list of delegated permissions to add.
24
24
 
25
25
  `--grantAdminConsent`
@@ -37,19 +37,19 @@ If you have multiple apps registered in your .m365rc.json file, you can specify
37
37
  Adds the specified application permissions to the default app registered in the _.m365rc.json_ file while granting admin consent.
38
38
 
39
39
  ```sh
40
- m365 app permission add --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
40
+ m365 app permission add --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
41
41
  ```
42
42
 
43
43
  Adds the specified delegated permissions to the default app registered in the _.m365rc.json_ file without granting admin consent.
44
44
 
45
45
  ```sh
46
- m365 app permission add --delegatedPermission 'https://graph.microsoft.com/offline_access'
46
+ m365 app permission add --delegatedPermissions 'https://graph.microsoft.com/offline_access'
47
47
  ```
48
48
 
49
49
  Adds the specified application and delegated permissions to a specific app registered in the _.m365rc.json_ file while granting admin consent.
50
50
 
51
51
  ```sh
52
- m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermission 'https://graph.microsoft.com/offline_access' --grantAdminConsent
52
+ m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermissions 'https://graph.microsoft.com/offline_access' --grantAdminConsent
53
53
  ```
54
54
 
55
55
  ## Response
@@ -16,7 +16,7 @@ m365 cli consent [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-s, --service <service>`
19
- : Service for which to consent permissions. Allowed values: `VivaEngage`, (deprecated)`yammer`.
19
+ : Service for which to consent permissions. Allowed values: `VivaEngage`.
20
20
  ```
21
21
 
22
22
  <Global />
@@ -22,39 +22,39 @@ m365 entra sp add [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `--appId [appId]`
26
- : ID of the app for which the enterprise application should be created
25
+ `-i, --id [id]`
26
+ : ID of the app for which the enterprise application should be created.
27
27
 
28
- `--appName [appName]`
29
- : Display name of the app for which the enterprise application should be created
28
+ `-n, --displayName [displayName]`
29
+ : Display name of the app for which the enterprise application should be created.
30
30
 
31
31
  `--objectId [objectId]`
32
- : ObjectId of the app for which the enterprise application should be created
32
+ : ObjectId of the app for which the enterprise application should be created.
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `appId`, `appName` or `objectId`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `id`, `displayName` or `objectId`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  If you register an application in the portal, an application object as well as an enterprise application object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the enterprise application separately. To register/create an application using the CLI for Microsoft 365, use the [m365 entra app add](../app/app-add.mdx) command.
42
42
 
43
43
  ## Examples
44
44
 
45
- Creates an enterprise application for a registered Entra app with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
45
+ Creates an enterprise application for a registered Entra app with the specified id.
46
46
 
47
47
  ```sh
48
- m365 entra enterpriseapp add --appId b2307a39-e878-458b-bc90-03bc578531d6
48
+ m365 entra enterpriseapp add --id b2307a39-e878-458b-bc90-03bc578531d6
49
49
  ```
50
50
 
51
- Creates an enterprise application for a registered Entra app with appName _Microsoft Graph_.
51
+ Creates an enterprise application for a registered Entra app with the specified displayName.
52
52
 
53
53
  ```sh
54
- m365 entra enterpriseapp add --appName "Microsoft Graph"
54
+ m365 entra enterpriseapp add --displayName "Microsoft Graph"
55
55
  ```
56
56
 
57
- Creates an enterprise application for a registered Entra app with objectId _b2307a39-e878-458b-bc90-03bc578531d6_.
57
+ Creates an enterprise application for a registered Entra app with the specified objectId.
58
58
 
59
59
  ```sh
60
60
  m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
@@ -172,7 +172,7 @@ m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
172
172
  <TabItem value="Markdown">
173
173
 
174
174
  ```md
175
- # entra enterpriseapp add --appId "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
175
+ # entra enterpriseapp add --id "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
176
176
 
177
177
  Date: 2023-06-02
178
178
 
@@ -22,40 +22,40 @@ m365 entra sp get [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `-i, --appId [appId]`
26
- : ID of the application for which the enterprise application should be retrieved
25
+ `-i, --id [id]`
26
+ : ID of the application for which the enterprise application should be retrieved.
27
27
 
28
- `-n, --appDisplayName [appDisplayName]`
29
- : Display name of the application for which the enterprise application should be retrieved
28
+ `-n, --displayName [displayName]`
29
+ : Display name of the application for which the enterprise application should be retrieved.
30
30
 
31
- `--appObjectId [appObjectId]`
32
- : ObjectId of the application for which the enterprise application should be retrieved
31
+ `--objectId [objectId]`
32
+ : ObjectId of the application for which the enterprise application should be retrieved.
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `appId`, `appObjectId` or `appDisplayName`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `id`, `objectId` or `displayName`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  ## Examples
42
42
 
43
- Return details about the enterprise application with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
43
+ Return details about the enterprise application with the specified id.
44
44
 
45
45
  ```sh
46
- m365 entra enterpriseapp get --appId b2307a39-e878-458b-bc90-03bc578531d6
46
+ m365 entra enterpriseapp get --id b2307a39-e878-458b-bc90-03bc578531d6
47
47
  ```
48
48
 
49
- Return details about the _Microsoft Graph_ enterprise application.
49
+ Return details about the enterprise application with the specified displayName.
50
50
 
51
51
  ```sh
52
- m365 entra enterpriseapp get --appDisplayName "Microsoft Graph"
52
+ m365 entra enterpriseapp get --displayName "Microsoft Graph"
53
53
  ```
54
54
 
55
- Return details about the enterprise application with ObjectId _b2307a39-e878-458b-bc90-03bc578531dd_.
55
+ Return details about the enterprise application with the specified ObjectId.
56
56
 
57
57
  ```sh
58
- m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
58
+ m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
59
59
  ```
60
60
 
61
61
  ## Response
@@ -198,7 +198,7 @@ m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
198
198
  <TabItem value="Markdown">
199
199
 
200
200
  ```md
201
- # entra enterpriseapp get --appId "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
201
+ # entra enterpriseapp get --id "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
202
202
 
203
203
  Date: 2023-06-02
204
204
 
@@ -22,24 +22,24 @@ m365 entra sp list [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `--displayName [displayName]`
26
- : Returns only enterprise applications with the specified name
25
+ `-n, --displayName [displayName]`
26
+ : Returns only enterprise applications with the specified name.
27
27
 
28
28
  `--tag [tag]`
29
- : Returns only enterprise applications with the specified tag
29
+ : Returns only enterprise applications with the specified tag.
30
30
  ```
31
31
 
32
32
  <Global />
33
33
 
34
34
  ## Examples
35
35
 
36
- Return a list of all enterprise applications
36
+ Returns a list of all enterprise applications.
37
37
 
38
38
  ```sh
39
39
  m365 entra enterpriseapp list
40
40
  ```
41
41
 
42
- Return a list of all enterprise applications that comply with the display name and the tag parameters
42
+ Returns a list of all enterprise applications that comply with the specified display name and the tag parameters.
43
43
 
44
44
  ```sh
45
45
  m365 entra enterpriseapp list --displayName "My custom enterprise application" --tag "WindowsAzureActiveDirectoryIntegratedApp"
@@ -22,10 +22,10 @@ m365 aad group user list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The ID of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
25
+ : The ID of the Entra group. Specify `groupId` or `groupName` but not both.
26
26
 
27
- `-n, --groupDisplayName [groupDisplayName]`
28
- : The display name of the Entra group. Specify `groupId` or `groupDisplayName` but not both.
27
+ `-n, --groupName [groupName]`
28
+ : The display name of the Entra group. Specify `groupId` or `groupName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
31
  : Filter the results to only users with the given role: `Owner`, `Member`.
@@ -54,25 +54,25 @@ m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
54
54
  List all owners from a group specified by display name.
55
55
 
56
56
  ```sh
57
- m365 entra group user list --groupDisplayName Developers --role Owner
57
+ m365 entra group user list --groupName Developers --role Owner
58
58
  ```
59
59
 
60
60
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
61
61
 
62
62
  ```sh
63
- m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/displayName"
63
+ m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
64
64
  ```
65
65
 
66
66
  List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
67
67
 
68
68
  ```sh
69
- m365 entra group user list --groupDisplayName Developers --properties "displayName,mail,manager/*"
69
+ m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
70
70
  ```
71
71
 
72
72
  List all group members that are guest users.
73
73
 
74
74
  ```sh
75
- m365 entra group user list --groupDisplayName Developers --filter "userType eq 'Guest'"
75
+ m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
76
76
  ```
77
77
 
78
78
  ## Response
@@ -22,10 +22,10 @@ m365 aad m365group conversation post list [options]
22
22
 
23
23
  ```md definition-list
24
24
  `-i, --groupId [groupId]`
25
- : The Id of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
25
+ : The Id of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
26
26
 
27
- `-d, --groupDisplayName [groupDisplayName]`
28
- : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupDisplayName, but not both.
27
+ `-d, --groupName [groupName]`
28
+ : The Displayname of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
29
29
 
30
30
  `-t, --threadId <threadId>`
31
31
  : The ID of the thread to retrieve details for
@@ -41,10 +41,10 @@ Lists the posts of the specific conversation of Microsoft 365 group by groupId
41
41
  m365 entra m365group conversation post list --groupId '00000000-0000-0000-0000-000000000000' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
42
42
  ```
43
43
 
44
- Lists the posts of the specific conversation of Microsoft 365 group by groupDisplayName
44
+ Lists the posts of the specific conversation of Microsoft 365 group by groupName
45
45
 
46
46
  ```sh
47
- m365 entra m365group conversation post list --groupDisplayName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
47
+ m365 entra m365group conversation post list --groupName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
48
48
  ```
49
49
 
50
50
  ## Response
@@ -21,7 +21,7 @@ m365 aad m365group recyclebinitem list [options]
21
21
  ## Options
22
22
 
23
23
  ```md definition-list
24
- `-d, --groupDisplayName [groupDisplayName]`
24
+ `-d, --groupName [groupName]`
25
25
  : Lists groups with DisplayName starting with the specified value
26
26
 
27
27
  `-m, --groupMailNickname [groupMailNickname]`
@@ -41,7 +41,7 @@ m365 entra m365group recyclebinitem list
41
41
  List deleted Microsoft 365 Groups with display name starting with _Project_
42
42
 
43
43
  ```sh
44
- m365 entra m365group recyclebinitem list --groupDisplayName Project
44
+ m365 entra m365group recyclebinitem list --groupName Project
45
45
  ```
46
46
 
47
47
  List deleted Microsoft 365 Groups mail nick name starting with _team_
@@ -53,7 +53,7 @@ m365 entra m365group recyclebinitem list --groupMailNickname team
53
53
  List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
54
54
 
55
55
  ```sh
56
- m365 entra m365group recyclebinitem list --groupMailNickname team --groupDisplayName Project
56
+ m365 entra m365group recyclebinitem list --groupMailNickname team --groupName Project
57
57
  ```
58
58
 
59
59
  ## Response
@@ -9,13 +9,13 @@ Get the total storage used across all group mailboxes and group sites
9
9
  ## Usage
10
10
 
11
11
  ```sh
12
- m365 entra m365group report activitystorage [options]
12
+ m365 entra m365group report activitystorage [options]
13
13
  ```
14
14
 
15
15
  ## Alias
16
16
 
17
17
  ```sh
18
- m365 aad m365group report activitystorage [options]
18
+ m365 aad m365group report activitystorage [options]
19
19
  ```
20
20
 
21
21
  ## Options
@@ -28,7 +28,7 @@ m365 aad m365group user list [options]
28
28
  : The display name of the Microsoft 365 group. Specify `groupId` or `groupDisplayName` but not both.
29
29
 
30
30
  `-r, --role [role]`
31
- : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`, or (Deprecated) `Guest`.
31
+ : Filter the results to only users with the given role. Allowed values: `Owner`, `Member`.
32
32
 
33
33
  `-p, --properties [properties]`
34
34
  : Comma-separated list of properties to retrieve.
@@ -0,0 +1,79 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+
3
+ # file move
4
+
5
+ Moves a file to another location using the Microsoft Graph
6
+
7
+ ## Usage
8
+
9
+ ```sh
10
+ m365 file move [options]
11
+ ```
12
+
13
+ ## Options
14
+
15
+ ```md definition-list
16
+ `-u, --webUrl <webUrl>`
17
+ : The URL of the site where the file is located.
18
+
19
+ `-s, --sourceUrl <sourceUrl>`
20
+ : Server-relative or absolute URL of the file.
21
+
22
+ `-t, --targetUrl <targetUrl>`
23
+ : Server-relative or absolute URL of the location.
24
+
25
+ `--newName [newName]`
26
+ : New name of the destination file.
27
+
28
+ `--nameConflictBehavior [nameConflictBehavior]`
29
+ : Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`.
30
+ ```
31
+
32
+ <Global />
33
+
34
+ ## Remarks
35
+
36
+ - If the source and target locations are within the same document library or drive, the command will utilize the Move DriveItem API, preserving the version history of the file.
37
+ - If the source and target locations are in different document libraries or drives, the command will use a copy-and-delete combination to move the file. Please note that in this case, version history will not be retained.
38
+
39
+ ## Examples
40
+
41
+ Move a file by server-relative URL to a folder in the same document library
42
+
43
+ ```sh
44
+ m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/project/Shared Documents/NewFolder"
45
+ ```
46
+
47
+ Move a file by server-relative URL to a document library in another site collection with server relative URL
48
+
49
+ ```sh
50
+ m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
51
+ ```
52
+
53
+ Move a file by absolute URL to a document library in another site collection with absolute URL
54
+
55
+ ```sh
56
+ m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "https://contoso.sharepoint.com/Shared Documents/Document.pdf" --targetUrl "https://contoso.sharepoint.com/sites/IT/Shared Documents"
57
+ ```
58
+
59
+ Move a file to a document library in another site collection and rename the file
60
+
61
+ ```sh
62
+ m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --newName "newName"
63
+ ```
64
+
65
+ Move a file to a document library in another site collection and rename the file if a file with the same name already exists.
66
+
67
+ ```sh
68
+ m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --nameConflictBehavior rename
69
+ ```
70
+
71
+ Move a file to Onedrive for business
72
+
73
+ ```sh
74
+ m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/documents"
75
+ ```
76
+
77
+ ## Response
78
+
79
+ The command won't return a response on success.
@@ -19,10 +19,10 @@ m365 outlook message get [options]
19
19
  : ID of the message.
20
20
 
21
21
  `--userId [userId]`
22
- : ID of the user from which to retrieve the message. Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
22
+ : ID of the user from which to retrieve the message. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
23
23
 
24
- `--userPrincipalName [userPrincipalName]`
25
- : UPN of the user from which to retrieve the message Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
24
+ `--userName [userName]`
25
+ : UPN of the user from which to retrieve the message Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
26
26
  ```
27
27
 
28
28
  <Global />
@@ -38,7 +38,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
38
38
  Get a specific message using delegated permissions from a shared mailbox.
39
39
 
40
40
  ```sh
41
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName sharedmailbox@tenant.com
41
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName sharedmailbox@tenant.com
42
42
  ```
43
43
 
44
44
  Get a specific message from a specific user retrieved by user ID using application permissions.
@@ -50,7 +50,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
50
50
  Get a specific message from a specific user retrieved by user principal name using application permissions.
51
51
 
52
52
  ```sh
53
- m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName user@tenant.com
53
+ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName user@tenant.com
54
54
  ```
55
55
 
56
56
  ## Response
@@ -37,7 +37,7 @@ The command will ask you the following questions:
37
37
 
38
38
  - _How do you plan to use the CLI?_
39
39
 
40
- You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors and show spinners. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
40
+ You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
41
41
 
42
42
  - _Are you going to use the CLI in PowerShell?_ (asked only when you chose to configure CLI for scripting)
43
43
 
@@ -60,7 +60,6 @@ The `m365 setup` command uses the following presets:
60
60
  - printErrorsAsPlainText: true,
61
61
  - prompt: true,
62
62
  - showHelpOnFailure: true,
63
- - showSpinner: true
64
63
  - scripting use:
65
64
  - autoOpenLinksInBrowser: false,
66
65
  - copyDeviceCodeToClipboard: false,
@@ -68,7 +67,6 @@ The `m365 setup` command uses the following presets:
68
67
  - printErrorsAsPlainText: false,
69
68
  - prompt: false,
70
69
  - showHelpOnFailure: false,
71
- - showSpinner: false
72
70
  - use in PowerShell:
73
71
  - errorOutput: 'stdout'
74
72
  - beginner:
@@ -14,28 +14,25 @@ m365 spfx project github workflow add [options]
14
14
 
15
15
  ```md definition-list
16
16
  `-n, --name [name]`
17
- : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
17
+ : Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'.
18
18
 
19
19
  `-b, --branchName [branchName]`
20
- : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
20
+ : Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'.
21
21
 
22
22
  `-m, --manuallyTrigger`
23
- : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`
23
+ : When specified a manual trigger option will be added to the workflow: `workflow_dispatch`.
24
24
 
25
25
  `-l, --loginMethod [loginMethod]`
26
- : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`'
26
+ : Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`.
27
27
 
28
28
  `-s, --scope [scope]`
29
- : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`
29
+ : Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`.
30
30
 
31
31
  `-u, --siteUrl [siteUrl]`
32
- : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`
32
+ : The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`.
33
33
 
34
34
  `--skipFeatureDeployment`
35
- : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
36
-
37
- `--overwrite`
38
- : When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
35
+ : When specified and the app supports tenant-wide deployment, deploy it to the whole tenant.
39
36
  ```
40
37
 
41
38
  <Global />
@@ -59,6 +56,8 @@ For the `user` login method you will need to create the following secrets in Git
59
56
 
60
57
  This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
61
58
 
59
+ The workflow will overwrite the existing .sppkg if it is already deployed in the app catalog. Overwriting your sppkg file on every deployment is required to make continuous delivery of the latest version of your app which is the aim of the continuous delivery pipeline.
60
+
62
61
  :::info
63
62
 
64
63
  Run this command in the SPFx solution folder.
@@ -67,7 +66,7 @@ Run this command in the SPFx solution folder.
67
66
 
68
67
  ## Examples
69
68
 
70
- Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
69
+ Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main.
71
70
 
72
71
  ```sh
73
72
  m365 spfx project github workflow add
@@ -79,7 +78,7 @@ Adds a GitHub workflow for a SharePoint Framework project with `user` login meth
79
78
  m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
80
79
  ```
81
80
 
82
- Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
81
+ Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog.
83
82
 
84
83
  ```sh
85
84
  m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"