@pnp/cli-microsoft365 5.0.0-beta.431ccea → 5.0.0-beta.460e9b7

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 (100) hide show
  1. package/.devcontainer/devcontainer.json +9 -1
  2. package/.eslintrc.js +2 -0
  3. package/README.md +1 -1
  4. package/dist/Utils.js +7 -0
  5. package/dist/appInsights.js +3 -2
  6. package/dist/cli/Cli.js +20 -3
  7. package/dist/m365/aad/commands/app/app-add.js +58 -5
  8. package/dist/m365/aad/commands/app/app-get.js +97 -0
  9. package/dist/m365/aad/commands/group/group-list.js +41 -0
  10. package/dist/m365/aad/commands/o365group/{GroupUser.js → GroupExtended.js} +1 -1
  11. package/dist/m365/aad/commands/o365group/o365group-add.js +56 -50
  12. package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
  13. package/dist/m365/aad/commands/user/user-get.js +33 -6
  14. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  15. package/dist/m365/aad/commands/user/user-list.js +7 -4
  16. package/dist/m365/aad/commands/user/user-password-validate.js +42 -0
  17. package/dist/m365/aad/commands.js +4 -0
  18. package/dist/m365/app/commands/permission/permission-list.js +266 -0
  19. package/dist/m365/app/commands.js +7 -0
  20. package/dist/m365/base/AppCommand.js +76 -0
  21. package/dist/m365/{aad/commands/o365group/Group.js → base/M365RcJson.js} +1 -1
  22. package/dist/m365/cli/commands/cli-doctor.js +2 -0
  23. package/dist/m365/cli/commands/config/config-set.js +4 -1
  24. package/dist/m365/flow/commands/flow-get.js +2 -2
  25. package/dist/m365/pa/cds-project-mutator.js +1 -1
  26. package/dist/m365/pa/commands/app/app-list.js +28 -1
  27. package/dist/m365/planner/AppliedCategories.js +3 -0
  28. package/dist/m365/planner/commands/task/task-add.js +288 -0
  29. package/dist/m365/planner/commands/task/task-set.js +357 -0
  30. package/dist/m365/planner/commands.js +3 -1
  31. package/dist/m365/search/commands/externalconnection/externalconnection-add.js +99 -0
  32. package/dist/m365/search/commands.js +7 -0
  33. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006005_CFG_PS_metadata.js +63 -0
  34. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +60 -0
  35. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
  36. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.13.1.js +53 -0
  37. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0-beta.5.js +59 -0
  38. package/dist/m365/spfx/commands/project/project-upgrade.js +17 -13
  39. package/dist/m365/spfx/commands/spfx-doctor.js +19 -0
  40. package/dist/m365/spo/commands/contenttype/contenttype-list.js +52 -0
  41. package/dist/m365/spo/commands/group/group-user-add.js +64 -13
  42. package/dist/m365/spo/commands/page/Page.js +3 -1
  43. package/dist/m365/spo/commands/page/page-add.js +7 -10
  44. package/dist/m365/spo/commands/page/page-set.js +7 -10
  45. package/dist/m365/spo/commands/site/site-ensure.js +1 -1
  46. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  47. package/dist/m365/spo/commands/web/web-installedlanguage-list.js +48 -0
  48. package/dist/m365/spo/commands.js +4 -1
  49. package/dist/m365/teams/commands/app/app-list.js +9 -6
  50. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  51. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  52. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  53. package/dist/m365/teams/commands/message/message-get.js +1 -1
  54. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  55. package/dist/m365/teams/commands.js +3 -0
  56. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
  57. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
  58. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +39 -0
  59. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +38 -0
  60. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js +51 -0
  61. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +38 -0
  62. package/dist/m365/tenant/commands.js +6 -0
  63. package/dist/request.js +9 -4
  64. package/dist/settingsNames.js +6 -1
  65. package/docs/docs/cmd/_global.md +2 -2
  66. package/docs/docs/cmd/aad/app/app-add.md +11 -0
  67. package/docs/docs/cmd/aad/app/app-get.md +48 -0
  68. package/docs/docs/cmd/aad/group/group-list.md +21 -0
  69. package/docs/docs/cmd/aad/o365group/o365group-add.md +1 -0
  70. package/docs/docs/cmd/aad/user/user-get.md +13 -4
  71. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  72. package/docs/docs/cmd/aad/user/user-list.md +9 -0
  73. package/docs/docs/cmd/aad/user/user-password-validate.md +29 -0
  74. package/docs/docs/cmd/app/permission/permission-list.md +36 -0
  75. package/docs/docs/cmd/pa/app/app-list.md +17 -1
  76. package/docs/docs/cmd/planner/task/task-add.md +78 -0
  77. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  78. package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +43 -0
  79. package/docs/docs/cmd/spfx/project/project-externalize.md +1 -1
  80. package/docs/docs/cmd/spfx/project/project-rename.md +1 -1
  81. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  82. package/docs/docs/cmd/spfx/spfx-doctor.md +1 -1
  83. package/docs/docs/cmd/spo/contenttype/contenttype-list.md +33 -0
  84. package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
  85. package/docs/docs/cmd/spo/page/page-add.md +2 -2
  86. package/docs/docs/cmd/spo/page/page-set.md +3 -3
  87. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  88. package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +24 -0
  89. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  90. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  91. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  92. package/docs/docs/cmd/teams/message/message-get.md +0 -3
  93. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
  94. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
  95. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +24 -0
  96. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +34 -0
  97. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +28 -0
  98. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +34 -0
  99. package/npm-shrinkwrap.json +699 -940
  100. package/package.json +27 -20
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphCommand_1 = require("../../../base/GraphCommand");
4
+ const request_1 = require("../../../../request");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_GET;
9
+ }
10
+ get description() {
11
+ return 'This operation provides the health information of a specified service for a tenant';
12
+ }
13
+ getTelemetryProperties(args) {
14
+ const telemetryProps = super.getTelemetryProperties(args);
15
+ telemetryProps.issues = typeof args.options.issues !== 'undefined';
16
+ return telemetryProps;
17
+ }
18
+ defaultProperties() {
19
+ return ['id', 'status', 'service'];
20
+ }
21
+ commandAction(logger, args, cb) {
22
+ this
23
+ .getServiceHealth(args.options)
24
+ .then((res) => {
25
+ logger.log(res);
26
+ cb();
27
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
28
+ }
29
+ getServiceHealth(options) {
30
+ const requestOptions = {
31
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews/${options.serviceName}${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
32
+ headers: {
33
+ accept: 'application/json;odata.metadata=none'
34
+ },
35
+ responseType: 'json'
36
+ };
37
+ return request_1.default
38
+ .get(requestOptions)
39
+ .then(response => {
40
+ const serviceHealth = response;
41
+ if (!serviceHealth) {
42
+ return Promise.reject(`Error fetching service health`);
43
+ }
44
+ return Promise.resolve(serviceHealth);
45
+ });
46
+ }
47
+ options() {
48
+ const options = [
49
+ { option: '-s, --serviceName <serviceName>' },
50
+ { option: '-i, --issues' }
51
+ ];
52
+ const parentOptions = super.options();
53
+ return options.concat(parentOptions);
54
+ }
55
+ }
56
+ module.exports = new TenantServiceAnnouncementHealthGetCommand();
57
+ //# sourceMappingURL=serviceannouncement-health-get.js.map
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphCommand_1 = require("../../../base/GraphCommand");
4
+ const request_1 = require("../../../../request");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_LIST;
9
+ }
10
+ get description() {
11
+ return 'This operation provides the health report of all subscribed services for a tenant';
12
+ }
13
+ getTelemetryProperties(args) {
14
+ const telemetryProps = super.getTelemetryProperties(args);
15
+ telemetryProps.issues = typeof args.options.issues !== 'undefined';
16
+ return telemetryProps;
17
+ }
18
+ defaultProperties() {
19
+ return ['id', 'status', 'service'];
20
+ }
21
+ commandAction(logger, args, cb) {
22
+ this
23
+ .listServiceHealth(args.options)
24
+ .then((res) => {
25
+ logger.log(res);
26
+ cb();
27
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
28
+ }
29
+ listServiceHealth(options) {
30
+ const requestOptions = {
31
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
32
+ headers: {
33
+ accept: 'application/json;odata.metadata=none'
34
+ },
35
+ responseType: 'json'
36
+ };
37
+ return request_1.default
38
+ .get(requestOptions)
39
+ .then(response => {
40
+ const serviceHealthList = response.value;
41
+ if (!serviceHealthList) {
42
+ return Promise.reject(`Error fetching service health`);
43
+ }
44
+ return Promise.resolve(serviceHealthList);
45
+ });
46
+ }
47
+ options() {
48
+ const options = [
49
+ { option: '-i, --issues' }
50
+ ];
51
+ const parentOptions = super.options();
52
+ return options.concat(parentOptions);
53
+ }
54
+ }
55
+ module.exports = new TenantServiceAnnouncementHealthListCommand();
56
+ //# sourceMappingURL=serviceannouncement-health-list.js.map
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const GraphCommand_1 = require("../../../base/GraphCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementHealthIssueGetCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_GET;
9
+ }
10
+ get description() {
11
+ return 'Gets a specified service health issue for tenant';
12
+ }
13
+ commandAction(logger, args, cb) {
14
+ const requestOptions = {
15
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/issues/${encodeURIComponent(args.options.id)}`,
16
+ headers: {
17
+ accept: 'application/json;odata.metadata=none'
18
+ },
19
+ responseType: 'json'
20
+ };
21
+ request_1.default
22
+ .get(requestOptions)
23
+ .then((res) => {
24
+ logger.log(res);
25
+ cb();
26
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
27
+ }
28
+ options() {
29
+ const options = [
30
+ {
31
+ option: '-i, --id <id>'
32
+ }
33
+ ];
34
+ const parentOptions = super.options();
35
+ return options.concat(parentOptions);
36
+ }
37
+ }
38
+ module.exports = new TenantServiceAnnouncementHealthIssueGetCommand();
39
+ //# sourceMappingURL=serviceannouncement-healthissue-get.js.map
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
4
+ const commands_1 = require("../../commands");
5
+ class TenantServiceAnnouncementHealthIssueListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.SERVICEANNOUNCEMENT_HEALTHISSUE_LIST;
8
+ }
9
+ get description() {
10
+ return 'Gets all service health issues for the tenant';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'title'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/issues`;
17
+ if (args.options.service) {
18
+ endpoint += `?$filter=service eq '${encodeURIComponent(args.options.service)}'`;
19
+ }
20
+ this
21
+ .getAllItems(endpoint, logger, true)
22
+ .then(() => {
23
+ logger.log(this.items);
24
+ cb();
25
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
26
+ }
27
+ options() {
28
+ const options = [
29
+ {
30
+ option: '-s, --service [service]'
31
+ }
32
+ ];
33
+ const parentOptions = super.options();
34
+ return options.concat(parentOptions);
35
+ }
36
+ }
37
+ module.exports = new TenantServiceAnnouncementHealthIssueListCommand();
38
+ //# sourceMappingURL=serviceannouncement-healthissue-list.js.map
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const GraphCommand_1 = require("../../../base/GraphCommand");
5
+ const commands_1 = require("../../commands");
6
+ class TenantServiceAnnouncementMessageGetCommand extends GraphCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_GET;
9
+ }
10
+ get description() {
11
+ return 'Retrieves a specified service update message for the tenant';
12
+ }
13
+ commandAction(logger, args, cb) {
14
+ if (this.verbose) {
15
+ logger.logToStderr(`Retrieving service update message ${args.options.id}`);
16
+ }
17
+ const requestOptions = {
18
+ url: `${this.resource}/v1.0/admin/serviceAnnouncement/messages/${args.options.id}`,
19
+ headers: {
20
+ accept: 'application/json;odata.metadata=none'
21
+ },
22
+ responseType: 'json'
23
+ };
24
+ request_1.default
25
+ .get(requestOptions)
26
+ .then((res) => {
27
+ logger.log(res);
28
+ cb();
29
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
30
+ }
31
+ options() {
32
+ const options = [
33
+ {
34
+ option: '-i, --id <id>'
35
+ }
36
+ ];
37
+ const parentOptions = super.options();
38
+ return options.concat(parentOptions);
39
+ }
40
+ isValidId(id) {
41
+ return (/MC\d{6}/).test(id);
42
+ }
43
+ validate(args) {
44
+ if (!this.isValidId(args.options.id)) {
45
+ return `${args.options.id} is not a valid message ID`;
46
+ }
47
+ return true;
48
+ }
49
+ }
50
+ module.exports = new TenantServiceAnnouncementMessageGetCommand();
51
+ //# sourceMappingURL=serviceannouncement-message-get.js.map
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
4
+ const commands_1 = require("../../commands");
5
+ class TenantServiceAnnouncementMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.SERVICEANNOUNCEMENT_MESSAGE_LIST;
8
+ }
9
+ get description() {
10
+ return 'Gets all service update messages for the tenant';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'title'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ let endpoint = `${this.resource}/v1.0/admin/serviceAnnouncement/messages`;
17
+ if (args.options.service) {
18
+ endpoint += `?$filter=services/any(c:c+eq+'${encodeURIComponent(args.options.service)}')`;
19
+ }
20
+ this
21
+ .getAllItems(endpoint, logger, true)
22
+ .then(() => {
23
+ logger.log(this.items);
24
+ cb();
25
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
26
+ }
27
+ options() {
28
+ const options = [
29
+ {
30
+ option: '-s, --service [service]'
31
+ }
32
+ ];
33
+ const parentOptions = super.options();
34
+ return options.concat(parentOptions);
35
+ }
36
+ }
37
+ module.exports = new TenantServiceAnnouncementMessageListCommand();
38
+ //# sourceMappingURL=serviceannouncement-message-list.js.map
@@ -10,9 +10,15 @@ exports.default = {
10
10
  REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
11
11
  REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
12
12
  REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
13
+ SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
13
14
  SERVICE_LIST: `${prefix} service list`,
14
15
  SERVICE_MESSAGE_LIST: `${prefix} service message list`,
15
16
  SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
17
+ SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
18
+ SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
19
+ SERVICEANNOUNCEMENT_HEALTHISSUE_LIST: `${prefix} serviceannouncement healthissue list`,
20
+ SERVICEANNOUNCEMENT_MESSAGE_GET: `${prefix} serviceannouncement message get`,
21
+ SERVICEANNOUNCEMENT_MESSAGE_LIST: `${prefix} serviceannouncement message list`,
16
22
  STATUS_LIST: `${prefix} status list`
17
23
  };
18
24
  //# sourceMappingURL=commands.js.map
package/dist/request.js CHANGED
@@ -16,7 +16,9 @@ class Request {
16
16
  decompress: true,
17
17
  responseType: 'text',
18
18
  /* c8 ignore next */
19
- transformResponse: [data => data]
19
+ transformResponse: [data => data],
20
+ maxBodyLength: Infinity,
21
+ maxContentLength: Infinity
20
22
  });
21
23
  // since we're stubbing requests, request interceptor is never called in
22
24
  // tests, so let's exclude it from coverage
@@ -64,7 +66,7 @@ class Request {
64
66
  });
65
67
  // since we're stubbing requests, response interceptor is never called in
66
68
  // tests, so let's exclude it from coverage
67
- /* c8 ignore next 22 */
69
+ /* c8 ignore next 26 */
68
70
  this.req.interceptors.response.use((response) => {
69
71
  if (this._logger) {
70
72
  this._logger.logToStderr('Response:');
@@ -73,19 +75,22 @@ class Request {
73
75
  response.headers['content-type'].indexOf('json') > -1) {
74
76
  properties.push('data');
75
77
  }
76
- this._logger.logToStderr(JSON.stringify(Utils_1.default.filterObject(response, properties), null, 2));
78
+ this._logger.logToStderr(JSON.stringify(Object.assign({ url: response.config.url }, Utils_1.default.filterObject(response, properties)), null, 2));
77
79
  }
78
80
  return response;
79
81
  }, (error) => {
80
82
  if (this._logger) {
81
83
  const properties = ['status', 'statusText', 'headers'];
82
84
  this._logger.logToStderr('Request error:');
83
- this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({}, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
85
+ this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({ url: error.config.url }, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
84
86
  }
85
87
  throw error;
86
88
  });
87
89
  }
88
90
  }
91
+ get logger() {
92
+ return this._logger;
93
+ }
89
94
  set logger(logger) {
90
95
  this._logger = logger;
91
96
  }
@@ -5,7 +5,12 @@ const settingsNames = {
5
5
  errorOutput: 'errorOutput',
6
6
  output: 'output',
7
7
  printErrorsAsPlainText: 'printErrorsAsPlainText',
8
- showHelpOnFailure: 'showHelpOnFailure'
8
+ showHelpOnFailure: 'showHelpOnFailure',
9
+ csvHeader: 'csvHeader',
10
+ csvEscape: 'csvEscape',
11
+ csvQuote: 'csvQuote',
12
+ csvQuoted: 'csvQuoted',
13
+ csvQuotedEmpty: 'csvQuotedEmpty'
9
14
  };
10
15
  exports.settingsNames = settingsNames;
11
16
  //# sourceMappingURL=settingsNames.js.map
@@ -5,10 +5,10 @@
5
5
  : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
6
6
 
7
7
  `-o, --output [output]`
8
- : Output type. `json,text`. Default `text`
8
+ : Output type. `json,text,csv`. Default `json`
9
9
 
10
10
  `--verbose`
11
11
  : Runs command with verbose logging
12
12
 
13
13
  `--debug`
14
- : Runs command with debug logging
14
+ : Runs command with debug logging
@@ -52,6 +52,9 @@ m365 aad app add [options]
52
52
  `--manifest [manifest]`
53
53
  : Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
54
54
 
55
+ `--save`
56
+ : Use to store the information about the created app in a local file
57
+
55
58
  --8<-- "docs/cmd/_global.md"
56
59
 
57
60
  ## Remarks
@@ -80,6 +83,8 @@ When using the `withSecret` option, this command will automatically generate a s
80
83
 
81
84
  After creating the Azure AD app registration, this command returns the app ID and object ID of the created app registration. If you used the `withSecret` option, it will also return the generated secret.
82
85
 
86
+ If you want to store the information about the created Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you create the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the to it, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
87
+
83
88
  ## Examples
84
89
 
85
90
  Create new Azure AD app registration with the specified name
@@ -141,3 +146,9 @@ Create new Azure AD app registration with Application ID URI set to a value that
141
146
  ```sh
142
147
  m365 aad app add --name 'My AAD app' --uri api://caf406b91cd4.ngrok.io/_appId_ --scopeName access_as_user --scopeAdminConsentDescription 'Access as a user' --scopeAdminConsentDisplayName 'Access as a user' --scopeConsentBy adminsAndUsers
143
148
  ```
149
+
150
+ Create new Azure AD app registration with the specified name. Store information about the created app registration in the _.m365rc.json_ file in the current directory.
151
+
152
+ ```sh
153
+ m365 aad app add --name 'My AAD app' --save
154
+ ```
@@ -0,0 +1,48 @@
1
+ # aad app get
2
+
3
+ Gets an Azure AD app registration
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad app get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Application (client) ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
15
+
16
+ `--objectId [objectId]`
17
+ : Object ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
18
+
19
+ `--name [name]`
20
+ : Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
27
+
28
+ If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
29
+
30
+ ## Examples
31
+
32
+ Get the Azure AD application registration by its app (client) ID
33
+
34
+ ```sh
35
+ m365 aad app get --appId d75be2e1-0204-4f95-857d-51a37cf40be8
36
+ ```
37
+
38
+ Get the Azure AD application registration by its object ID
39
+
40
+ ```sh
41
+ m365 aad app get --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
42
+ ```
43
+
44
+ Get the Azure AD application registration by its name
45
+
46
+ ```sh
47
+ m365 aad app get --name "My app"
48
+ ```
@@ -0,0 +1,21 @@
1
+ # aad group list
2
+
3
+ Lists Azure AD groups
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad group list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ --8<-- "docs/cmd/_global.md"
14
+
15
+ ## Examples
16
+
17
+ Lists all groups defined in Azure Active Directory.
18
+
19
+ ```sh
20
+ m365 aad group list
21
+ ```
@@ -36,6 +36,7 @@ m365 aad o365group add [options]
36
36
  ## Remarks
37
37
 
38
38
  When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
39
+ If an invalid user is provided in the comma-separated list or Owners or Members, the command operation will fail and the Micrsoft 365 Group will not be created.
39
40
 
40
41
  ## Examples
41
42
 
@@ -11,10 +11,13 @@ m365 aad user get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : The ID of the user to retrieve information for. Specify `id` or `userName` but not both
14
+ : The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
15
15
 
16
16
  `-n, --userName [userName]`
17
- : The name of the user to retrieve information for. Specify `id` or `userName` but not both
17
+ : The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
+
19
+ `--email [email]`
20
+ : The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
18
21
 
19
22
  `-p, --properties [properties]`
20
23
  : Comma-separated list of properties to retrieve
@@ -23,9 +26,9 @@ m365 aad user get [options]
23
26
 
24
27
  ## Remarks
25
28
 
26
- You can retrieve information about a user, either by specifying that user's id or user name (`userPrincipalName`), but not both.
29
+ You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
27
30
 
28
- If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
31
+ If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
29
32
 
30
33
  ## Examples
31
34
 
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
41
44
  m365 aad user get --userName AarifS@contoso.onmicrosoft.com
42
45
  ```
43
46
 
47
+ Get information about the user with email _AarifS@contoso.onmicrosoft.com_
48
+
49
+ ```sh
50
+ m365 aad user get --email AarifS@contoso.onmicrosoft.com
51
+ ```
52
+
44
53
  For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
45
54
 
46
55
  ```sh
@@ -0,0 +1,46 @@
1
+ # aad user hibp
2
+
3
+ Allows you to retrieve all accounts that have been pwned with the specified username
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user hibp [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --userName <userName>`
14
+ : The name of the user to retrieve information for.
15
+
16
+ `--apiKey, <apiKey>`
17
+ : Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
18
+
19
+ `--domain, [domain]`
20
+ : Limit the returned breaches only contain results with the domain specified.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
27
+
28
+ If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
29
+
30
+ ## Examples
31
+
32
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
33
+
34
+ ```sh
35
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
36
+ ```
37
+
38
+ Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
39
+
40
+ ```sh
41
+ m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
42
+ ```
43
+
44
+ ## More information
45
+
46
+ - Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)
@@ -13,6 +13,9 @@ m365 aad user list [options]
13
13
  `-p, --properties [properties]`
14
14
  : Comma-separated list of properties to retrieve
15
15
 
16
+ `-d, --deleted`
17
+ : Use to retrieve deleted users
18
+
16
19
  --8<-- "docs/cmd/_global.md"
17
20
 
18
21
  ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
31
34
  m365 aad user list
32
35
  ```
33
36
 
37
+ List all recently deleted users in the tenant
38
+
39
+ ```sh
40
+ m365 aad user list --deleted
41
+ ```
42
+
34
43
  List all users in the tenant. For each one return the display name and e-mail address
35
44
 
36
45
  ```sh
@@ -0,0 +1,29 @@
1
+ # aad user password validate
2
+
3
+ Check a user's password against the organization's password validation policy
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user password validate [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-p, --password <password>`
14
+ : The password to be validated.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! attention
21
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
22
+
23
+ ## Examples
24
+
25
+ Validate password _cli365P@ssW0rd_ against the organization's password validation policy
26
+
27
+ ```sh
28
+ m365 aad user password validate --password "cli365P@ssW0rd"
29
+ ```
@@ -0,0 +1,36 @@
1
+ # app permission list
2
+
3
+ Lists API permissions for the current AAD app
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 app permission list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ Use this command to quickly look up API permissions for the Azure AD application registration registered in the .m365rc.json file in your current project (folder).
21
+
22
+ If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
23
+
24
+ ## Examples
25
+
26
+ Retrieve API permissions for your current Azure AD app
27
+
28
+ ```sh
29
+ m365 app permission list
30
+ ```
31
+
32
+ Retrieve API permissions for the Azure AD app with client ID _e23d235c-fcdf-45d1-ac5f-24ab2ee0695d_ specified in the _.m365rc.json_ file
33
+
34
+ ```sh
35
+ m365 app permission list --appId e23d235c-fcdf-45d1-ac5f-24ab2ee0695d
36
+ ```