@pnp/cli-microsoft365 7.0.0-beta.90ef876 → 7.0.0-beta.e25bf4a

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 (180) hide show
  1. package/dist/Command.js +1 -1
  2. package/dist/cli/Cli.js +23 -8
  3. package/dist/m365/aad/commands/user/user-get.js +7 -1
  4. package/dist/m365/aad/commands/user/user-set.js +20 -20
  5. package/dist/m365/booking/commands/business/business-get.js +14 -15
  6. package/dist/m365/cli/commands/config/config-set.js +1 -1
  7. package/dist/m365/pa/commands/app/app-consent-set.js +2 -2
  8. package/dist/m365/pa/commands/app/app-export.js +3 -3
  9. package/dist/m365/pa/commands/app/app-list.js +5 -5
  10. package/dist/m365/pa/commands/app/app-owner-set.js +115 -0
  11. package/dist/m365/pa/commands/app/app-permission-list.js +104 -0
  12. package/dist/m365/pa/commands.js +2 -0
  13. package/dist/m365/planner/commands/bucket/bucket-add.js +14 -10
  14. package/dist/m365/planner/commands/bucket/bucket-get.js +25 -19
  15. package/dist/m365/planner/commands/bucket/bucket-list.js +14 -10
  16. package/dist/m365/planner/commands/bucket/bucket-remove.js +26 -20
  17. package/dist/m365/planner/commands/bucket/bucket-set.js +26 -28
  18. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -14
  19. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +2 -2
  20. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +2 -2
  21. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +3 -3
  22. package/dist/m365/pp/commands/card/card-clone.js +3 -3
  23. package/dist/m365/pp/commands/card/card-get.js +2 -2
  24. package/dist/m365/pp/commands/card/card-list.js +2 -2
  25. package/dist/m365/pp/commands/card/card-remove.js +3 -3
  26. package/dist/m365/pp/commands/chatbot/chatbot-get.js +2 -2
  27. package/dist/m365/pp/commands/chatbot/chatbot-list.js +3 -3
  28. package/dist/m365/pp/commands/chatbot/chatbot-remove.js +3 -3
  29. package/dist/m365/pp/commands/dataverse/dataverse-table-get.js +2 -2
  30. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +2 -2
  31. package/dist/m365/pp/commands/dataverse/dataverse-table-remove.js +2 -2
  32. package/dist/m365/pp/commands/dataverse/dataverse-table-row-list.js +2 -2
  33. package/dist/m365/pp/commands/dataverse/dataverse-table-row-remove.js +2 -2
  34. package/dist/m365/pp/commands/solution/solution-get.js +2 -2
  35. package/dist/m365/pp/commands/solution/solution-list.js +2 -2
  36. package/dist/m365/pp/commands/solution/solution-publish.js +3 -3
  37. package/dist/m365/pp/commands/solution/solution-publisher-add.js +2 -2
  38. package/dist/m365/pp/commands/solution/solution-publisher-get.js +2 -2
  39. package/dist/m365/pp/commands/solution/solution-publisher-list.js +2 -2
  40. package/dist/m365/pp/commands/solution/solution-publisher-remove.js +3 -3
  41. package/dist/m365/pp/commands/solution/solution-remove.js +3 -3
  42. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +19 -17
  43. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +19 -17
  44. package/dist/m365/search/commands/externalconnection/externalconnection-remove.js +35 -34
  45. package/dist/m365/spfx/commands/project/project-externalize/rules/DynamicRule.js +59 -51
  46. package/dist/m365/spo/commands/file/file-list.js +3 -14
  47. package/dist/m365/spo/commands/folder/folder-remove.js +30 -28
  48. package/dist/m365/spo/commands/list/list-add.js +0 -9
  49. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +0 -4
  50. package/dist/m365/spo/commands/list/list-retentionlabel-get.js +0 -4
  51. package/dist/m365/spo/commands/list/list-roleassignment-add.js +9 -47
  52. package/dist/m365/spo/commands/list/list-set.js +0 -9
  53. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +4 -4
  54. package/dist/m365/spo/commands/page/page-remove.js +33 -31
  55. package/dist/m365/spo/commands/roledefinition/roledefinition-remove.js +25 -23
  56. package/dist/m365/spo/commands/site/site-apppermission-add.js +3 -3
  57. package/dist/m365/spo/commands/site/site-commsite-enable.js +9 -18
  58. package/dist/m365/spo/commands/site/site-set.js +10 -2
  59. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +13 -16
  60. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-set.js +80 -2
  61. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +48 -48
  62. package/dist/m365/spo/commands/theme/theme-get.js +1 -2
  63. package/dist/m365/spo/commands/user/user-get.js +5 -5
  64. package/dist/m365/spo/commands.js +0 -2
  65. package/dist/m365/teams/commands/chat/chat-get.js +4 -4
  66. package/dist/m365/teams/commands/chat/chat-member-add.js +117 -0
  67. package/dist/m365/teams/commands/chat/chat-message-send.js +4 -4
  68. package/dist/m365/teams/commands/meeting/meeting-get.js +16 -24
  69. package/dist/m365/teams/commands/meeting/meeting-list.js +2 -15
  70. package/dist/m365/teams/commands/team/team-app-list.js +1 -1
  71. package/dist/m365/teams/commands.js +1 -0
  72. package/dist/utils/spo.js +74 -0
  73. package/docs/docs/_clisettings.mdx +1 -1
  74. package/docs/docs/cmd/_global.mdx +1 -1
  75. package/docs/docs/cmd/aad/user/user-get.mdx +118 -25
  76. package/docs/docs/cmd/aad/user/user-set.mdx +11 -11
  77. package/docs/docs/cmd/pa/app/app-consent-set.mdx +3 -3
  78. package/docs/docs/cmd/pa/app/app-export.mdx +3 -3
  79. package/docs/docs/cmd/pa/app/app-list.mdx +2 -2
  80. package/docs/docs/cmd/pa/app/app-owner-set.mdx +60 -0
  81. package/docs/docs/cmd/pa/app/app-permission-list.mdx +132 -0
  82. package/docs/docs/cmd/planner/bucket/bucket-add.mdx +21 -4
  83. package/docs/docs/cmd/planner/bucket/bucket-get.mdx +22 -5
  84. package/docs/docs/cmd/planner/bucket/bucket-list.mdx +21 -4
  85. package/docs/docs/cmd/planner/bucket/bucket-remove.mdx +21 -4
  86. package/docs/docs/cmd/planner/bucket/bucket-set.mdx +22 -5
  87. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.mdx +4 -4
  88. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.mdx +4 -4
  89. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.mdx +4 -4
  90. package/docs/docs/cmd/pp/card/card-clone.mdx +6 -6
  91. package/docs/docs/cmd/pp/card/card-get.mdx +6 -6
  92. package/docs/docs/cmd/pp/card/card-list.mdx +4 -4
  93. package/docs/docs/cmd/pp/card/card-remove.mdx +9 -9
  94. package/docs/docs/cmd/pp/chatbot/chatbot-get.mdx +6 -6
  95. package/docs/docs/cmd/pp/chatbot/chatbot-list.mdx +4 -4
  96. package/docs/docs/cmd/pp/chatbot/chatbot-remove.mdx +4 -4
  97. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.mdx +2 -2
  98. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.mdx +2 -2
  99. package/docs/docs/cmd/pp/dataverse/dataverse-table-remove.mdx +1 -1
  100. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.mdx +5 -5
  101. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.mdx +5 -5
  102. package/docs/docs/cmd/pp/solution/solution-get.mdx +6 -6
  103. package/docs/docs/cmd/pp/solution/solution-list.mdx +4 -4
  104. package/docs/docs/cmd/pp/solution/solution-publish.mdx +4 -4
  105. package/docs/docs/cmd/pp/solution/solution-publisher-add.mdx +3 -3
  106. package/docs/docs/cmd/pp/solution/solution-publisher-get.mdx +6 -6
  107. package/docs/docs/cmd/pp/solution/solution-publisher-list.mdx +4 -4
  108. package/docs/docs/cmd/pp/solution/solution-publisher-remove.mdx +5 -5
  109. package/docs/docs/cmd/pp/solution/solution-remove.mdx +9 -9
  110. package/docs/docs/cmd/spo/file/file-list.mdx +6 -10
  111. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  112. package/docs/docs/cmd/spo/list/list-add.mdx +0 -3
  113. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.mdx +0 -6
  114. package/docs/docs/cmd/spo/list/list-retentionlabel-get.mdx +0 -6
  115. package/docs/docs/cmd/spo/list/list-set.mdx +0 -3
  116. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx +7 -7
  117. package/docs/docs/cmd/spo/site/site-add.mdx +35 -0
  118. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +5 -1
  119. package/docs/docs/cmd/spo/site/site-appcatalog-list.mdx +14 -0
  120. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +4 -0
  121. package/docs/docs/cmd/spo/site/site-apppermission-add.mdx +68 -0
  122. package/docs/docs/cmd/spo/site/site-apppermission-get.mdx +55 -0
  123. package/docs/docs/cmd/spo/site/site-apppermission-list.mdx +55 -0
  124. package/docs/docs/cmd/spo/site/site-apppermission-remove.mdx +4 -0
  125. package/docs/docs/cmd/spo/site/site-apppermission-set.mdx +66 -0
  126. package/docs/docs/cmd/spo/site/site-chrome-set.mdx +4 -0
  127. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +11 -1
  128. package/docs/docs/cmd/spo/site/site-ensure.mdx +70 -0
  129. package/docs/docs/cmd/spo/site/site-get.mdx +179 -0
  130. package/docs/docs/cmd/spo/site/site-groupify.mdx +54 -0
  131. package/docs/docs/cmd/spo/site/site-hubsite-connect.mdx +4 -0
  132. package/docs/docs/cmd/spo/site/site-hubsite-disconnect.mdx +4 -0
  133. package/docs/docs/cmd/spo/site/site-hubsite-theme-sync.mdx +5 -1
  134. package/docs/docs/cmd/spo/site/site-inplacerecordsmanagement-set.mdx +4 -0
  135. package/docs/docs/cmd/spo/site/site-list.mdx +303 -0
  136. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +80 -0
  137. package/docs/docs/cmd/spo/site/site-recyclebinitem-restore.mdx +4 -0
  138. package/docs/docs/cmd/spo/site/site-remove.mdx +4 -0
  139. package/docs/docs/cmd/spo/site/site-rename.mdx +92 -0
  140. package/docs/docs/cmd/spo/site/site-set.mdx +13 -0
  141. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.mdx +116 -0
  142. package/docs/docs/cmd/spo/sitedesign/sitedesign-apply.mdx +125 -0
  143. package/docs/docs/cmd/spo/sitedesign/sitedesign-get.mdx +117 -0
  144. package/docs/docs/cmd/spo/sitedesign/sitedesign-list.mdx +94 -0
  145. package/docs/docs/cmd/spo/sitedesign/sitedesign-remove.mdx +4 -0
  146. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-grant.mdx +4 -0
  147. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-list.mdx +54 -0
  148. package/docs/docs/cmd/spo/sitedesign/sitedesign-rights-revoke.mdx +4 -0
  149. package/docs/docs/cmd/spo/sitedesign/sitedesign-run-list.mdx +66 -0
  150. package/docs/docs/cmd/spo/sitedesign/sitedesign-run-status-get.mdx +65 -0
  151. package/docs/docs/cmd/spo/sitedesign/sitedesign-set.mdx +117 -0
  152. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-get.mdx +61 -0
  153. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-list.mdx +60 -0
  154. package/docs/docs/cmd/spo/sitedesign/sitedesign-task-remove.mdx +4 -0
  155. package/docs/docs/cmd/spo/sitescript/sitescript-add.mdx +75 -0
  156. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +62 -0
  157. package/docs/docs/cmd/spo/sitescript/sitescript-list.mdx +60 -0
  158. package/docs/docs/cmd/spo/sitescript/sitescript-remove.mdx +4 -0
  159. package/docs/docs/cmd/spo/sitescript/sitescript-set.mdx +63 -0
  160. package/docs/docs/cmd/spo/storageentity/storageentity-get.mdx +53 -0
  161. package/docs/docs/cmd/spo/storageentity/storageentity-list.mdx +54 -0
  162. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +4 -0
  163. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +4 -0
  164. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +4 -0
  165. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +35 -0
  166. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +12 -3
  167. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +67 -0
  168. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +4 -0
  169. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +50 -0
  170. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +729 -0
  171. package/docs/docs/cmd/spo/tenant/tenant-settings-set.mdx +5 -0
  172. package/docs/docs/cmd/spo/theme/theme-apply.mdx +35 -0
  173. package/docs/docs/cmd/spo/theme/theme-get.mdx +74 -0
  174. package/docs/docs/cmd/spo/theme/theme-list.mdx +52 -0
  175. package/docs/docs/cmd/spo/theme/theme-remove.mdx +4 -0
  176. package/docs/docs/cmd/spo/theme/theme-set.mdx +4 -0
  177. package/docs/docs/cmd/spo/user/user-get.mdx +6 -6
  178. package/docs/docs/cmd/teams/chat/chat-member-add.mdx +66 -0
  179. package/npm-shrinkwrap.json +212 -212
  180. package/package.json +10 -10
@@ -21,8 +21,8 @@ const GraphCommand_1 = require("../../../base/GraphCommand");
21
21
  const commands_1 = require("../../commands");
22
22
  const odata_1 = require("../../../../utils/odata");
23
23
  const validation_1 = require("../../../../utils/validation");
24
- const AadUserGetCommand = require("../../../aad/commands/user/user-get");
25
24
  const accessToken_1 = require("../../../../utils/accessToken");
25
+ const aadUser_1 = require("../../../../utils/aadUser");
26
26
  class TeamsMeetingListCommand extends GraphCommand_1.default {
27
27
  get name() {
28
28
  return commands_1.default.MEETING_LIST;
@@ -60,7 +60,7 @@ class TeamsMeetingListCommand extends GraphCommand_1.default {
60
60
  requestUrl += args.options.userName;
61
61
  }
62
62
  else if (args.options.email) {
63
- const userId = yield this.getUserId(args.options.email);
63
+ const userId = yield aadUser_1.aadUser.getUserIdByEmail(args.options.email);
64
64
  requestUrl += userId;
65
65
  }
66
66
  }
@@ -98,19 +98,6 @@ class TeamsMeetingListCommand extends GraphCommand_1.default {
98
98
  }
99
99
  });
100
100
  }
101
- getUserId(email) {
102
- return __awaiter(this, void 0, void 0, function* () {
103
- const options = {
104
- email: email,
105
- output: 'json',
106
- debug: this.debug,
107
- verbose: this.verbose
108
- };
109
- const output = yield Cli_1.Cli.executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
110
- const getUserOutput = JSON.parse(output.stdout);
111
- return getUserOutput.id;
112
- });
113
- }
114
101
  }
115
102
  _TeamsMeetingListCommand_instances = new WeakSet(), _TeamsMeetingListCommand_initTelemetry = function _TeamsMeetingListCommand_initTelemetry() {
116
103
  this.telemetry.push((args) => {
@@ -43,7 +43,7 @@ class TeamsTeamAppListCommand extends GraphCommand_1.default {
43
43
  return __awaiter(this, void 0, void 0, function* () {
44
44
  try {
45
45
  if (this.verbose) {
46
- logger.logToStderr(`Retrieving installed apps for team '${args.options.teamId || args.options.teamId}'`);
46
+ logger.logToStderr(`Retrieving installed apps for team '${args.options.teamId || args.options.teamName}'`);
47
47
  }
48
48
  const teamId = yield this.getTeamId(args);
49
49
  const res = yield odata_1.odata.getAllItems(`${this.resource}/v1.0/teams/${teamId}/installedApps?$expand=teamsApp,teamsAppDefinition`);
@@ -20,6 +20,7 @@ exports.default = {
20
20
  CHANNEL_SET: `${prefix} channel set`,
21
21
  CHAT_GET: `${prefix} chat get`,
22
22
  CHAT_LIST: `${prefix} chat list`,
23
+ CHAT_MEMBER_ADD: `${prefix} chat member add`,
23
24
  CHAT_MEMBER_LIST: `${prefix} chat member list`,
24
25
  CHAT_MEMBER_REMOVE: `${prefix} chat member remove`,
25
26
  CHAT_MESSAGE_LIST: `${prefix} chat message list`,
package/dist/utils/spo.js CHANGED
@@ -19,6 +19,7 @@ const base_permissions_1 = require("../m365/spo/base-permissions");
19
19
  const request_1 = require("../request");
20
20
  const formatting_1 = require("./formatting");
21
21
  const odata_1 = require("./odata");
22
+ const RoleType_1 = require("../m365/spo/commands/roledefinition/RoleType");
22
23
  exports.spo = {
23
24
  getRequestDigest(siteUrl) {
24
25
  const requestOptions = {
@@ -569,6 +570,30 @@ exports.spo = {
569
570
  return res.AadObjectId.NameId;
570
571
  });
571
572
  },
573
+ /**
574
+ * Retrieves the spo user by email.
575
+ * @param webUrl Web url
576
+ * @param email The email of the user
577
+ * @param logger the Logger object
578
+ * @param debug set if debug logging should be logged
579
+ */
580
+ getUserByEmail(webUrl, email, logger, debug) {
581
+ return __awaiter(this, void 0, void 0, function* () {
582
+ if (debug) {
583
+ logger.logToStderr(`Retrieving the spo user by email ${email}`);
584
+ }
585
+ const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting_1.formatting.encodeQueryParameter(email)}')`;
586
+ const requestOptions = {
587
+ url: requestUrl,
588
+ headers: {
589
+ 'accept': 'application/json;odata=nometadata'
590
+ },
591
+ responseType: 'json'
592
+ };
593
+ const userInstance = yield request_1.default.get(requestOptions);
594
+ return userInstance;
595
+ });
596
+ },
572
597
  /**
573
598
  * Retrieves the menu state for the quick launch.
574
599
  * @param webUrl Web url
@@ -628,6 +653,55 @@ exports.spo = {
628
653
  };
629
654
  return request_1.default.post(requestOptions);
630
655
  });
656
+ },
657
+ /**
658
+ * Retrieves the spo group by name.
659
+ * @param webUrl Web url
660
+ * @param name The name of the group
661
+ * @param logger the Logger object
662
+ * @param debug set if debug logging should be logged
663
+ */
664
+ getGroupByName(webUrl, name, logger, debug) {
665
+ return __awaiter(this, void 0, void 0, function* () {
666
+ if (debug) {
667
+ logger.logToStderr(`Retrieving the group by name ${name}`);
668
+ }
669
+ const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting_1.formatting.encodeQueryParameter(name)}')`;
670
+ const requestOptions = {
671
+ url: requestUrl,
672
+ headers: {
673
+ 'accept': 'application/json;odata=nometadata'
674
+ },
675
+ responseType: 'json'
676
+ };
677
+ const groupInstance = yield request_1.default.get(requestOptions);
678
+ return groupInstance;
679
+ });
680
+ },
681
+ /**
682
+ * Retrieves the role definition by name.
683
+ * @param webUrl Web url
684
+ * @param name the name of the role definition
685
+ * @param logger the Logger object
686
+ * @param debug set if debug logging should be logged
687
+ */
688
+ getRoleDefinitionByName(webUrl, name, logger, debug) {
689
+ return __awaiter(this, void 0, void 0, function* () {
690
+ if (debug) {
691
+ logger.logToStderr(`Retrieving the role definitions for ${name}`);
692
+ }
693
+ const roledefinitions = yield odata_1.odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
694
+ const roledefinition = roledefinitions.find((role) => role.Name === name);
695
+ if (!roledefinition) {
696
+ throw `No roledefinition is found for ${name}`;
697
+ }
698
+ const permissions = new base_permissions_1.BasePermissions();
699
+ permissions.high = roledefinition.BasePermissions.High;
700
+ permissions.low = roledefinition.BasePermissions.Low;
701
+ roledefinition.BasePermissionsValue = permissions.parse();
702
+ roledefinition.RoleTypeKindValue = RoleType_1.RoleType[roledefinition.RoleTypeKind];
703
+ return roledefinition;
704
+ });
631
705
  }
632
706
  };
633
707
  //# sourceMappingURL=spo.js.map
@@ -10,7 +10,7 @@ Setting name|Definition|Default value
10
10
  `disableTelemetry`|Disables sending of telemetry data|`false`
11
11
  `errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
12
12
  `helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
13
- `output`|Defines the default output when issuing a command|`json`
13
+ `output`|Defines the default output when issuing a command. Allowed values are `json`, `text`, `csv`, `md`, `none`|`json`
14
14
  `printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
15
15
  `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.|`false`
16
16
  `showHelpOnFailure`|Automatically display help when executing a command failed|`true`
@@ -6,7 +6,7 @@
6
6
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
7
7
 
8
8
  `-o, --output [output]`
9
- : Output type. `json`, `text`, `csv`, `md`. Default `json`.
9
+ : Output type. `json`, `text`, `csv`, `md`, `none`. Default `json`.
10
10
 
11
11
  `--verbose`
12
12
  : Runs command with verbose logging.
@@ -25,7 +25,10 @@ m365 aad user get [options]
25
25
  : The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
26
26
 
27
27
  `-p, --properties [properties]`
28
- : Comma-separated list of properties to retrieve
28
+ : Comma-separated list of properties to retrieve.
29
+
30
+ `--withManager`
31
+ : Retrieve the direct manager of the user.
29
32
  ```
30
33
 
31
34
  <Global />
@@ -74,24 +77,113 @@ Get information about the currently logged in user using the UserName token
74
77
  m365 aad user get --userName "@meUserName"
75
78
  ```
76
79
 
80
+ Get information about a user with the manager's details
81
+
82
+ ```sh
83
+ m365 aad user get --userName AarifS@contoso.onmicrosoft.com --withManager
84
+ ```
85
+
77
86
  ## Response
78
87
 
88
+ ### Standard response
89
+
90
+ <Tabs>
91
+ <TabItem value="JSON">
92
+
93
+ ```json
94
+ {
95
+ "businessPhones": ["+32499-99-99-99"],
96
+ "displayName": "John Doe",
97
+ "givenName": "John",
98
+ "jobTitle": "Sales Manager",
99
+ "mail": "john.doe@contoso.com",
100
+ "mobilePhone": "+32499-99-99-99",
101
+ "officeLocation": "Vosselaar",
102
+ "preferredLanguage": "nl-BE",
103
+ "surname": "Doe",
104
+ "userPrincipalName": "john.doe@contoso.com",
105
+ "id": "990e2425-f595-43bc-85ed-b89a44093793"
106
+ }
107
+ ```
108
+
109
+ </TabItem>
110
+ <TabItem value="Text">
111
+
112
+ ```text
113
+ businessPhones : ["+32499-99-99-99"]
114
+ displayName : John Doe
115
+ givenName : John
116
+ id : 990e2425-f595-43bc-85ed-b89a44093793
117
+ jobTitle : Sales Manager
118
+ mail : john.doe@contoso.com
119
+ mobilePhone : +32499-99-99-99
120
+ officeLocation : Vosselaar
121
+ preferredLanguage: nl-BE
122
+ surname : Doe
123
+ userPrincipalName: john.doe@contoso.com
124
+ ```
125
+
126
+ </TabItem>
127
+ <TabItem value="CSV">
128
+
129
+ ```csv
130
+ displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
131
+ John Doe,John,Sales Manager,john.doe@contoso.com,+32499-99-99-99,Vosselaar,nl-BE,Doe,john.doe@contoso.com,990e2425-f595-43bc-85ed-b89a44093793
132
+ ```
133
+
134
+ </TabItem>
135
+ <TabItem value="Markdown">
136
+
137
+ ```md
138
+ # aad user get --userName "john.doe@contoso.com"
139
+
140
+ Date: 16/02/2023
141
+
142
+ ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
143
+
144
+ Property | Value
145
+ ---------|-------
146
+ displayName | John Doe
147
+ givenName | John
148
+ jobTitle | Sales Manager
149
+ mail | john.doe@contoso.com
150
+ mobilePhone | +32499-99-99-99
151
+ officeLocation | Vosselaar
152
+ preferredLanguage | nl-BE
153
+ surname | Doe
154
+ userPrincipalName | john.doe@contoso.com
155
+ id | 990e2425-f595-43bc-85ed-b89a44093793
156
+ ```
157
+
158
+ </TabItem>
159
+ </Tabs>
160
+
161
+ ### `withManager` response
162
+
163
+ When we make use of the option `withManager` the response will differ.
164
+
79
165
  <Tabs>
80
166
  <TabItem value="JSON">
81
167
 
82
168
  ```json
83
169
  {
84
- "businessPhones": [],
170
+ "businessPhones": ["+32499-99-99-99"],
85
171
  "displayName": "John Doe",
86
- "givenName": null,
87
- "jobTitle": null,
88
- "mail": null,
89
- "mobilePhone": null,
90
- "officeLocation": null,
91
- "preferredLanguage": null,
92
- "surname": null,
172
+ "givenName": "John",
173
+ "jobTitle": "Sales Manager",
174
+ "mail": "john.doe@contoso.com",
175
+ "mobilePhone": "+32499-99-99-99",
176
+ "officeLocation": "Vosselaar",
177
+ "preferredLanguage": "nl-BE",
178
+ "surname": "Doe",
93
179
  "userPrincipalName": "john.doe@contoso.com",
94
- "id": "74a3b772-3122-447b-b9da-10895e238219"
180
+ "id": "990e2425-f595-43bc-85ed-b89a44093793",
181
+ "manager": {
182
+ "displayName": "Jane Doe",
183
+ "userPrincipalName": "jane.doe@contoso.com",
184
+ "id": "eb77fbcf-6fe8-458b-985d-1747284793bc",
185
+ "mail": "jane.doe@contoso.com"
186
+ }
95
187
  }
96
188
  ```
97
189
 
@@ -99,16 +191,17 @@ m365 aad user get --userName "@meUserName"
99
191
  <TabItem value="Text">
100
192
 
101
193
  ```text
102
- businessPhones : []
194
+ businessPhones : ["+32499-99-99-99"]
103
195
  displayName : John Doe
104
- givenName : null
105
- id : 74a3b772-3122-447b-b9da-10895e238219
106
- jobTitle : null
107
- mail : null
108
- mobilePhone : null
109
- officeLocation : null
110
- preferredLanguage: null
111
- surname : null
196
+ givenName : John
197
+ id : 990e2425-f595-43bc-85ed-b89a44093793
198
+ jobTitle : Sales Manager
199
+ mail : john.doe@contoso.com
200
+ manager : {"displayName":"Jane Doe","userPrincipalName":"jane.doe@contoso.com","id":"eb77fbcf-6fe8-458b-985d-1747284793bc","mail":"jane.doe@contoso.com"}
201
+ mobilePhone : +32499-99-99-99
202
+ officeLocation : Vosselaar
203
+ preferredLanguage: nl-BE
204
+ surname : Doe
112
205
  userPrincipalName: john.doe@contoso.com
113
206
  ```
114
207
 
@@ -116,15 +209,15 @@ m365 aad user get --userName "@meUserName"
116
209
  <TabItem value="CSV">
117
210
 
118
211
  ```csv
119
- displayName,userPrincipalName,id
120
- John Doe,john.doe@contoso.com,74a3b772-3122-447b-b9da-10895e238219
212
+ displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
213
+ John Doe,John,Sales Manager,john.doe@contoso.com,+32499-99-99-99,Vosselaar,nl-BE,Doe,john.doe@contoso.com,990e2425-f595-43bc-85ed-b89a44093793
121
214
  ```
122
215
 
123
216
  </TabItem>
124
217
  <TabItem value="Markdown">
125
218
 
126
219
  ```md
127
- # aad user get --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName "John" --lastName "Doe" --jobTitle "Sales Manager" --officeLocation "Vosselaar" --preferredLanguage "nl-BE"
220
+ # aad user get --userName "john.doe@contoso.com" --withManager
128
221
 
129
222
  Date: 16/02/2023
130
223
 
@@ -135,13 +228,13 @@ m365 aad user get --userName "@meUserName"
135
228
  displayName | John Doe
136
229
  givenName | John
137
230
  jobTitle | Sales Manager
138
- mail | null
139
- mobilePhone | null
231
+ mail | john.doe@contoso.com
232
+ mobilePhone | +32499-99-99-99
140
233
  officeLocation | Vosselaar
141
234
  preferredLanguage | nl-BE
142
235
  surname | Doe
143
236
  userPrincipalName | john.doe@contoso.com
144
- id | 0649d0bd-53dc-4e1d-a357-76f1d92d447b
237
+ id | 990e2425-f595-43bc-85ed-b89a44093793
145
238
  ```
146
239
 
147
240
  </TabItem>
@@ -13,11 +13,11 @@ m365 aad user set [options]
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
- `-i, --objectId [objectId]`
17
- : The object ID of the user to update. Specify `objectId` or `userPrincipalName` but not both.
16
+ `-i, --id [id]`
17
+ : The object ID of the user to update. Specify `id` or `userName` but not both.
18
18
 
19
- `-n, --userPrincipalName [userPrincipalName]`
20
- : User principal name of the user to update. Specify `objectId` or `userPrincipalName` but not both.
19
+ `-n, --userName [userName]`
20
+ : User principal name of the user to update. Specify `id` or `userName` but not both.
21
21
 
22
22
  `--accountEnabled [accountEnabled]`
23
23
  : Boolean value specifying whether the account is enabled. Valid values are `true` or `false`.
@@ -87,36 +87,36 @@ If the user with the specified ID or username doesn't exist, or if the specified
87
87
  Update specific property _department_ of user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
88
88
 
89
89
  ```sh
90
- m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --Department IT
90
+ m365 aad user set --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --Department IT
91
91
  ```
92
92
 
93
93
  Update multiple properties of user by name
94
94
  ```sh
95
- m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --firstName John --lastName Doe --jobTitle "Sales Manager" --companyName Contoso --department Sales --officeLocation "New York"
95
+ m365 aad user set --userName steve@contoso.onmicrosoft.com --firstName John --lastName Doe --jobTitle "Sales Manager" --companyName Contoso --department Sales --officeLocation "New York"
96
96
  ```
97
97
 
98
98
  Enable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
99
99
 
100
100
  ```sh
101
- m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
101
+ m365 aad user set --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
102
102
  ```
103
103
 
104
104
  Disable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
105
105
 
106
106
  ```sh
107
- m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled false
107
+ m365 aad user set --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled false
108
108
  ```
109
109
 
110
- Reset password of a given user by userPrincipalName and require the user to change the password on the next sign in
110
+ Reset password of a given user by userName and require the user to change the password on the next sign in
111
111
 
112
112
  ```sh
113
- m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
113
+ m365 aad user set --userName steve@contoso.onmicrosoft.com --resetPassword --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
114
114
  ```
115
115
 
116
116
  Change password of the currently logged in user
117
117
 
118
118
  ```sh
119
- m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --currentPassword SLBF5gnRtyYc --newPassword 6NLUId79Lc24
119
+ m365 aad user set --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --currentPassword SLBF5gnRtyYc --newPassword 6NLUId79Lc24
120
120
  ```
121
121
 
122
122
  Updates a user with a manager
@@ -13,7 +13,7 @@ m365 pa app consent set [options]
13
13
  ## Options
14
14
 
15
15
  ```md definition-list
16
- `-e, --environment <environment>`
16
+ `-e, --environmentName <environmentName>`
17
17
  : The name of the environment.
18
18
 
19
19
  `-n, --name <name>`
@@ -37,13 +37,13 @@ This command only works for canvas apps.
37
37
  Enables the bypass for the specified canvas app
38
38
 
39
39
  ```sh
40
- m365 pa app consent set --environment 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass true
40
+ m365 pa app consent set --environmentName 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass true
41
41
  ```
42
42
 
43
43
  Disables the bypass consent for the specified canvas app
44
44
 
45
45
  ```sh
46
- m365 pa app consent set --environment 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass false --force
46
+ m365 pa app consent set --environmentName 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass false --force
47
47
  ```
48
48
 
49
49
  ## Response
@@ -16,7 +16,7 @@ m365 pa app export [options]
16
16
  `-i, --id <id>`
17
17
  : The id of the Power App to export
18
18
 
19
- `-e, --environment <environment>`
19
+ `-e, --environmentName <environmentName>`
20
20
  : The name of the environment for which to export the app
21
21
 
22
22
  `-n, --packageDisplayName [packageDisplayName]`
@@ -42,13 +42,13 @@ m365 pa app export [options]
42
42
  Export the specified Power App as a ZIP file
43
43
 
44
44
  ```sh
45
- m365 pa app export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d
45
+ m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp"
46
46
  ```
47
47
 
48
48
  Export the specified Power App as a ZIP file with the package displayname, package description, the one who created it, the package source environment and the path
49
49
 
50
50
  ```sh
51
- m365 pa app export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp" --packageDescription "Power App Description" --packageCreatedBy "John Doe" --packageSourceEnvironment "Contoso" --path "C:/Users/John/Documents"
51
+ m365 pa app export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp" --packageDescription "Power App Description" --packageCreatedBy "John Doe" --packageSourceEnvironment "Contoso" --path "C:/Users/John/Documents"
52
52
  ```
53
53
 
54
54
  ## Response
@@ -15,7 +15,7 @@ m365 pa app list [options]
15
15
  ## Options
16
16
 
17
17
  ```md definition-list
18
- `-e, --environment [environment]`
18
+ `-e, --environmentName [environmentName]`
19
19
  : The name of the environment for which to retrieve available apps
20
20
 
21
21
  `--asAdmin`
@@ -47,7 +47,7 @@ m365 pa app list
47
47
  List all apps in a given environment
48
48
 
49
49
  ```sh
50
- m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
50
+ m365 pa app list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
51
51
  ```
52
52
 
53
53
  ## Response
@@ -0,0 +1,60 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # pa app owner set
6
+
7
+ Sets a new owner for a Power Apps app
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 pa app owner set [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-e, --environmentName <environmentName>`
19
+ : The name of the environment.
20
+
21
+ `--appName <appName>`
22
+ : The name (GUID) of the Microsoft Power App.
23
+
24
+ `--userId [userId]`
25
+ : The Azure AD ID of the new owner. Specify either `userId` or `userName` but not both.
26
+
27
+ `--userName [userName]`
28
+ : The user principal name of the new owner. Specify either `userId` or `userName` but not both.
29
+
30
+ `--roleForOldAppOwner [roleForOldAppOwner]`
31
+ : Grant permissions for the previous owner. Allowed values: `CanView`, `CanEdit`. Don't specify a value to remove the previous owner from the app.
32
+ ```
33
+
34
+ <Global />
35
+
36
+ ## Remarks
37
+
38
+ :::info
39
+
40
+ To use this command you must be a Global or Power Platform admin.
41
+
42
+ :::
43
+
44
+ ## Examples
45
+
46
+ Set a new owner for a Power Apps app and make the previous owner co-owner
47
+
48
+ ```sh
49
+ m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userId c6ee6ed4-0172-4fdc-87a3-cfd9c324de1d --roleForOldAppOwner CanEdit
50
+ ```
51
+
52
+ Set a new owner for a Power Apps app and remove the previous owner
53
+
54
+ ```sh
55
+ m365 pa app owner set --environmentName Default-716eb9fb-bf79-4be9-b0c7-900824fcbe25 --appName 7ab97923-4a4d-4467-b030-12071d2b810b --userName john.doe@contoso.com
56
+ ```
57
+
58
+ ## Response
59
+
60
+ The command won't return a response on success.