@pnp/cli-microsoft365 5.5.0-beta.d1aff8a → 5.5.0-beta.f697eab

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 (68) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  3. package/dist/m365/base/PowerAppsCommand.js +10 -0
  4. package/dist/m365/pa/commands/app/app-get.js +3 -5
  5. package/dist/m365/pa/commands/app/app-list.js +10 -9
  6. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  7. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  8. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  9. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  10. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  11. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  12. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  13. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  14. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  15. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  16. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  17. package/dist/m365/planner/commands/plan/plan-get.js +1 -1
  18. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  19. package/dist/m365/planner/commands/task/task-add.js +15 -9
  20. package/dist/m365/planner/commands/task/task-get.js +14 -9
  21. package/dist/m365/planner/commands/task/task-list.js +19 -11
  22. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  23. package/dist/m365/planner/commands/task/task-set.js +15 -9
  24. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  25. package/dist/m365/search/commands.js +1 -0
  26. package/dist/m365/spo/base-permissions.js +9 -0
  27. package/dist/m365/spo/commands/field/field-set.js +16 -9
  28. package/dist/m365/spo/commands/group/group-add.js +96 -0
  29. package/dist/m365/spo/commands/group/group-set.js +167 -0
  30. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  31. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  32. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  33. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  34. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  35. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  36. package/dist/m365/spo/commands/site/site-classic-list.js +1 -0
  37. package/dist/m365/spo/commands/site/site-list.js +59 -17
  38. package/dist/m365/spo/commands.js +3 -0
  39. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  40. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  41. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  42. package/dist/utils/planner.js +6 -6
  43. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  44. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  45. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  46. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  47. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  48. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  49. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  50. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  51. package/docs/docs/cmd/planner/task/task-get.md +17 -8
  52. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  53. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  54. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  55. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  56. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  57. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  58. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  59. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  60. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  61. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  62. package/docs/docs/cmd/spo/site/site-classic-list.md +3 -0
  63. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  64. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  65. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  66. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  67. package/npm-shrinkwrap.json +173 -158
  68. package/package.json +13 -13
@@ -10,22 +10,25 @@ class SpoSiteListCommand extends SpoCommand_1.default {
10
10
  return commands_1.default.SITE_LIST;
11
11
  }
12
12
  get description() {
13
- return 'Lists modern sites of the given type';
13
+ return 'Lists sites of the given type';
14
14
  }
15
15
  getTelemetryProperties(args) {
16
16
  const telemetryProps = super.getTelemetryProperties(args);
17
- telemetryProps.siteType = args.options.type || 'TeamSite';
17
+ telemetryProps.webTemplate = args.options.webTemplate;
18
18
  telemetryProps.filter = (!(!args.options.filter)).toString();
19
- telemetryProps.deleted = args.options.deleted;
19
+ telemetryProps.includeOneDriveSites = typeof args.options.includeOneDriveSites !== 'undefined';
20
+ telemetryProps.deleted = typeof args.options.deleted !== 'undefined';
21
+ telemetryProps.siteType = args.options.type || 'TeamSite';
20
22
  return telemetryProps;
21
23
  }
22
24
  defaultProperties() {
23
25
  return ['Title', 'Url'];
24
26
  }
25
27
  commandAction(logger, args, cb) {
26
- const siteType = args.options.type || 'TeamSite';
27
- const webTemplate = siteType === 'TeamSite' ? 'GROUP#0' : 'SITEPAGEPUBLISHING#0';
28
- let spoAdminUrl;
28
+ const webTemplate = this.getWebTemplateId(args.options);
29
+ const includeOneDriveSites = args.options.includeOneDriveSites || false;
30
+ const personalSite = includeOneDriveSites === false ? '0' : '1';
31
+ let spoAdminUrl = '';
29
32
  utils_1.spo
30
33
  .getSpoAdminUrl(logger, this.debug)
31
34
  .then((_spoAdminUrl) => {
@@ -34,19 +37,19 @@ class SpoSiteListCommand extends SpoCommand_1.default {
34
37
  logger.logToStderr(`Retrieving list of site collections...`);
35
38
  }
36
39
  this.allSites = [];
37
- return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', webTemplate, undefined, args.options.deleted, logger);
40
+ return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, args.options.deleted, logger);
38
41
  })
39
42
  .then(_ => {
40
43
  logger.log(this.allSites);
41
44
  cb();
42
45
  }, (err) => this.handleRejectedPromise(err, logger, cb));
43
46
  }
44
- getAllSites(spoAdminUrl, filter, startIndex, webTemplate, formDigest, deleted, logger) {
47
+ getAllSites(spoAdminUrl, filter, startIndex, personalSite, webTemplate, formDigest, deleted, logger) {
45
48
  return new Promise((resolve, reject) => {
46
49
  utils_1.spo
47
50
  .ensureFormDigest(spoAdminUrl, logger, formDigest, this.debug)
48
51
  .then((res) => {
49
- let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">0</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
52
+ let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">${personalSite}</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
50
53
  if (deleted) {
51
54
  requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="4" ObjectPathId="3" /><ObjectPath Id="6" ObjectPathId="5" /><Query Id="7" ObjectPathId="5"><Query SelectAllProperties="true"><Properties><Property Name="NextStartIndexFromSharePoint" ScalarProperty="true" /></Properties></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="3" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="5" ParentId="3" Name="GetDeletedSitePropertiesFromSharePoint"><Parameters><Parameter Type="String">${startIndex}</Parameter></Parameters></Method></ObjectPaths></Request>`;
52
55
  }
@@ -71,7 +74,7 @@ class SpoSiteListCommand extends SpoCommand_1.default {
71
74
  this.allSites.push(...sites._Child_Items_);
72
75
  if (sites.NextStartIndexFromSharePoint) {
73
76
  this
74
- .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, webTemplate, formDigest, deleted, logger)
77
+ .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, personalSite, webTemplate, formDigest, deleted, logger)
75
78
  .then(_ => resolve(), err => reject(err));
76
79
  }
77
80
  else {
@@ -81,15 +84,48 @@ class SpoSiteListCommand extends SpoCommand_1.default {
81
84
  }, err => reject(err));
82
85
  });
83
86
  }
87
+ /*
88
+ The type property currently defaults to Teamsite.
89
+ It makes more sense to default to All. Certainly after adding the 'includeOneDriveSites' option.
90
+ Changing this will be a breaking change. We'll remove the default the next major version.
91
+ */
92
+ getWebTemplateId(options) {
93
+ if (options.webTemplate) {
94
+ return options.webTemplate;
95
+ }
96
+ if (options.includeOneDriveSites) {
97
+ return '';
98
+ }
99
+ let siteType = options.type;
100
+ if (!siteType) {
101
+ siteType = 'TeamSite';
102
+ }
103
+ switch (siteType) {
104
+ case "TeamSite":
105
+ return 'GROUP#0';
106
+ case "CommunicationSite":
107
+ return 'SITEPAGEPUBLISHING#0';
108
+ default:
109
+ return '';
110
+ }
111
+ }
84
112
  options() {
85
113
  const options = [
86
114
  {
87
- option: '--type [type]',
88
- autocomplete: ['TeamSite', 'CommunicationSite']
115
+ option: '-t, --type [type]',
116
+ // To not introduce a breaking change, 'All' has been added.
117
+ // You should use all when using '--includeOneDriveSites'
118
+ autocomplete: ['TeamSite', 'CommunicationSite', 'All']
119
+ },
120
+ {
121
+ option: '--webTemplate [webTemplate]'
89
122
  },
90
123
  {
91
124
  option: '-f, --filter [filter]'
92
125
  },
126
+ {
127
+ option: '--includeOneDriveSites'
128
+ },
93
129
  {
94
130
  option: '--deleted'
95
131
  }
@@ -98,11 +134,17 @@ class SpoSiteListCommand extends SpoCommand_1.default {
98
134
  return options.concat(parentOptions);
99
135
  }
100
136
  validate(args) {
101
- if (args.options.type) {
102
- if (args.options.type !== 'TeamSite' &&
103
- args.options.type !== 'CommunicationSite') {
104
- return `${args.options.type} is not a valid modern site type. Allowed types are TeamSite and CommunicationSite`;
105
- }
137
+ if (args.options.type && args.options.webTemplate) {
138
+ return 'Specify either type or webTemplate, but not both';
139
+ }
140
+ const typeValues = ['TeamSite', 'CommunicationSite', 'All'];
141
+ if (args.options.type &&
142
+ typeValues.indexOf(args.options.type) < 0) {
143
+ return `${args.options.type} is not a valid value for the type option. Allowed values are ${typeValues.join('|')}`;
144
+ }
145
+ if (args.options.includeOneDriveSites
146
+ && (!args.options.type || args.options.type !== 'All')) {
147
+ return 'When using includeOneDriveSites, specify All as value for type';
106
148
  }
107
149
  return true;
108
150
  }
@@ -63,9 +63,11 @@ exports.default = {
63
63
  FOLDER_REMOVE: `${prefix} folder remove`,
64
64
  FOLDER_RENAME: `${prefix} folder rename`,
65
65
  GET: `${prefix} get`,
66
+ GROUP_ADD: `${prefix} group add`,
66
67
  GROUP_GET: `${prefix} group get`,
67
68
  GROUP_LIST: `${prefix} group list`,
68
69
  GROUP_REMOVE: `${prefix} group remove`,
70
+ GROUP_SET: `${prefix} group set`,
69
71
  GROUP_USER_ADD: `${prefix} group user add`,
70
72
  GROUP_USER_LIST: `${prefix} group user list`,
71
73
  GROUP_USER_REMOVE: `${prefix} group user remove`,
@@ -167,6 +169,7 @@ exports.default = {
167
169
  REPORT_SITEUSAGEPAGES: `${prefix} report siteusagepages`,
168
170
  REPORT_SITEUSAGESITECOUNTS: `${prefix} report siteusagesitecounts`,
169
171
  REPORT_SITEUSAGESTORAGE: `${prefix} report siteusagestorage`,
172
+ ROLEDEFINITION_GET: `${prefix} roledefinition get`,
170
173
  ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
171
174
  ROLEDEFINITION_REMOVE: `${prefix} roledefinition remove`,
172
175
  SEARCH: `${prefix} search`,
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTeamArchiveCommand extends GraphCommand_1.default {
@@ -16,27 +17,53 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
16
17
  telemetryProps.shouldSetSpoSiteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
17
18
  return telemetryProps;
18
19
  }
20
+ getTeamId(args) {
21
+ if (args.options.id) {
22
+ return Promise.resolve(args.options.id);
23
+ }
24
+ return aadGroup_1.aadGroup
25
+ .getGroupByDisplayName(args.options.name)
26
+ .then(group => {
27
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
28
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
29
+ }
30
+ return group.id;
31
+ });
32
+ }
19
33
  commandAction(logger, args, cb) {
34
+ if (args.options.teamId) {
35
+ args.options.id = args.options.teamId;
36
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
37
+ }
20
38
  const siteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
21
- const requestOptions = {
22
- url: `${this.resource}/v1.0/teams/${encodeURIComponent(args.options.teamId)}/archive`,
23
- headers: {
24
- 'content-type': 'application/json;odata=nometadata',
25
- 'accept': 'application/json;odata.metadata=none'
26
- },
27
- responseType: 'json',
28
- data: {
29
- shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
30
- }
31
- };
32
- request_1.default
33
- .post(requestOptions)
39
+ this
40
+ .getTeamId(args)
41
+ .then((teamId) => {
42
+ const requestOptions = {
43
+ url: `${this.resource}/v1.0/teams/${encodeURIComponent(teamId)}/archive`,
44
+ headers: {
45
+ 'content-type': 'application/json;odata=nometadata',
46
+ 'accept': 'application/json;odata.metadata=none'
47
+ },
48
+ responseType: 'json',
49
+ data: {
50
+ shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
51
+ }
52
+ };
53
+ return request_1.default.post(requestOptions);
54
+ })
34
55
  .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
35
56
  }
36
57
  options() {
37
58
  const options = [
38
59
  {
39
- option: '-i, --teamId <teamId>'
60
+ option: '-i, --id [id]'
61
+ },
62
+ {
63
+ option: '-n, --name [name]'
64
+ },
65
+ {
66
+ option: '--teamId [teamId]'
40
67
  },
41
68
  {
42
69
  option: '--shouldSetSpoSiteReadOnlyForMembers'
@@ -46,9 +73,18 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
46
73
  return options.concat(parentOptions);
47
74
  }
48
75
  validate(args) {
49
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
76
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
77
+ return 'Specify either id or name';
78
+ }
79
+ if (args.options.name && (args.options.id || args.options.teamId)) {
80
+ return 'Specify either id or name but not both';
81
+ }
82
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
50
83
  return `${args.options.teamId} is not a valid GUID`;
51
84
  }
85
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
86
+ return `${args.options.id} is not a valid GUID`;
87
+ }
52
88
  return true;
53
89
  }
54
90
  }
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const cli_1 = require("../../../../cli");
4
4
  const request_1 = require("../../../../request");
5
5
  const utils_1 = require("../../../../utils");
6
+ const aadGroup_1 = require("../../../../utils/aadGroup");
6
7
  const GraphCommand_1 = require("../../../base/GraphCommand");
7
8
  const commands_1 = require("../../commands");
8
9
  class TeamsTeamRemoveCommand extends GraphCommand_1.default {
@@ -17,17 +18,37 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
17
18
  telemetryProps.confirm = (!(!args.options.confirm)).toString();
18
19
  return telemetryProps;
19
20
  }
21
+ getTeamId(args) {
22
+ if (args.options.id) {
23
+ return Promise.resolve(args.options.id);
24
+ }
25
+ return aadGroup_1.aadGroup
26
+ .getGroupByDisplayName(args.options.name)
27
+ .then(group => {
28
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
29
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
30
+ }
31
+ return group.id;
32
+ });
33
+ }
20
34
  commandAction(logger, args, cb) {
35
+ if (args.options.teamId) {
36
+ args.options.id = args.options.teamId;
37
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
38
+ }
21
39
  const removeTeam = () => {
22
- const requestOptions = {
23
- url: `${this.resource}/v1.0/groups/${encodeURIComponent(args.options.teamId)}`,
24
- headers: {
25
- accept: 'application/json;odata.metadata=none'
26
- },
27
- responseType: 'json'
28
- };
29
- request_1.default
30
- .delete(requestOptions)
40
+ this
41
+ .getTeamId(args)
42
+ .then((teamId) => {
43
+ const requestOptions = {
44
+ url: `${this.resource}/v1.0/groups/${encodeURIComponent(teamId)}`,
45
+ headers: {
46
+ accept: 'application/json;odata.metadata=none'
47
+ },
48
+ responseType: 'json'
49
+ };
50
+ return request_1.default.delete(requestOptions);
51
+ })
31
52
  .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
32
53
  };
33
54
  if (args.options.confirm) {
@@ -52,7 +73,13 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
52
73
  options() {
53
74
  const options = [
54
75
  {
55
- option: '-i, --teamId <teamId>'
76
+ option: '-i, --id [id]'
77
+ },
78
+ {
79
+ option: '-n, --name [name]'
80
+ },
81
+ {
82
+ option: '--teamId [teamId]'
56
83
  },
57
84
  {
58
85
  option: '--confirm'
@@ -62,9 +89,18 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
62
89
  return options.concat(parentOptions);
63
90
  }
64
91
  validate(args) {
65
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
92
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
93
+ return 'Specify either id or name';
94
+ }
95
+ if (args.options.name && (args.options.id || args.options.teamId)) {
96
+ return 'Specify either id or name but not both';
97
+ }
98
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
66
99
  return `${args.options.teamId} is not a valid GUID`;
67
100
  }
101
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
102
+ return `${args.options.id} is not a valid GUID`;
103
+ }
68
104
  return true;
69
105
  }
70
106
  }
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
@@ -11,33 +12,68 @@ class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
11
12
  get description() {
12
13
  return 'Restores an archived Microsoft Teams team';
13
14
  }
15
+ getTeamId(args) {
16
+ if (args.options.id) {
17
+ return Promise.resolve(args.options.id);
18
+ }
19
+ return aadGroup_1.aadGroup
20
+ .getGroupByDisplayName(args.options.name)
21
+ .then(group => {
22
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
23
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
24
+ }
25
+ return group.id;
26
+ });
27
+ }
14
28
  commandAction(logger, args, cb) {
29
+ if (args.options.teamId) {
30
+ args.options.id = args.options.teamId;
31
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
32
+ }
15
33
  const endpoint = `${this.resource}/v1.0`;
16
- const requestOptions = {
17
- url: `${endpoint}/teams/${encodeURIComponent(args.options.teamId)}/unarchive`,
18
- headers: {
19
- 'content-type': 'application/json;odata=nometadata',
20
- 'accept': 'application/json;odata.metadata=none'
21
- },
22
- responseType: 'json'
23
- };
24
- request_1.default
25
- .post(requestOptions)
34
+ this
35
+ .getTeamId(args)
36
+ .then((teamId) => {
37
+ const requestOptions = {
38
+ url: `${endpoint}/teams/${encodeURIComponent(teamId)}/unarchive`,
39
+ headers: {
40
+ 'content-type': 'application/json;odata=nometadata',
41
+ 'accept': 'application/json;odata.metadata=none'
42
+ },
43
+ responseType: 'json'
44
+ };
45
+ return request_1.default.post(requestOptions);
46
+ })
26
47
  .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
27
48
  }
28
49
  options() {
29
50
  const options = [
30
51
  {
31
- option: '-i, --teamId <teamId>'
52
+ option: '-i, --id [id]'
53
+ },
54
+ {
55
+ option: '-n, --name [name]'
56
+ },
57
+ {
58
+ option: '--teamId [teamId]'
32
59
  }
33
60
  ];
34
61
  const parentOptions = super.options();
35
62
  return options.concat(parentOptions);
36
63
  }
37
64
  validate(args) {
38
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
65
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
66
+ return 'Specify either id or name';
67
+ }
68
+ if (args.options.name && (args.options.id || args.options.teamId)) {
69
+ return 'Specify either id or name but not both';
70
+ }
71
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
39
72
  return `${args.options.teamId} is not a valid GUID`;
40
73
  }
74
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
75
+ return `${args.options.id} is not a valid GUID`;
76
+ }
41
77
  return true;
42
78
  }
43
79
  }
@@ -45,19 +45,19 @@ exports.planner = {
45
45
  return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
46
46
  },
47
47
  /**
48
- * Get Planner plan by name in a specific group.
49
- * @param name Name of the Planner plan. Case insensitive.
48
+ * Get Planner plan by title in a specific group.
49
+ * @param title Title of the Planner plan. Case insensitive.
50
50
  * @param groupId Owner group ID .
51
51
  */
52
- getPlanByName(name, groupId) {
52
+ getPlanByTitle(title, groupId) {
53
53
  return __awaiter(this, void 0, void 0, function* () {
54
54
  const plans = yield this.getPlansByGroupId(groupId);
55
- const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
55
+ const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
56
56
  if (!filteredPlans.length) {
57
- throw Error(`The specified plan '${name}' does not exist.`);
57
+ throw Error(`The specified plan '${title}' does not exist.`);
58
58
  }
59
59
  if (filteredPlans.length > 1) {
60
- throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
60
+ throw Error(`Multiple plans with title '${title}' found: ${filteredPlans.map(x => x.id)}.`);
61
61
  }
62
62
  return filteredPlans[0];
63
63
  });
@@ -16,15 +16,33 @@ m365 aad o365group restore [options]
16
16
 
17
17
  ## Options
18
18
 
19
- `-i, --id <id>`
20
- : The ID of the Microsoft 365 Group to restore
19
+ `-i, --id [id]`
20
+ : The ID of the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
21
+
22
+ `-d, --displayName [displayName]`
23
+ : Display name for the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
24
+
25
+ `-m, --mailNickname [mailNickname]`
26
+ : Name of the group e-mail (part before the @). Specify either `id`, `displayName` or `mailNickname` but not multiple.
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
24
30
  ## Examples
25
31
 
26
- Restores the Microsoft 365 Group with id _28beab62-7540-4db1-a23f-29a6018a3848_
32
+ Restores the Microsoft 365 Group with specific ID
27
33
 
28
34
  ```sh
29
35
  m365 aad o365group recyclebinitem restore --id 28beab62-7540-4db1-a23f-29a6018a3848
30
36
  ```
37
+
38
+ Restores the Microsoft 365 Group with specific name
39
+
40
+ ```sh
41
+ m365 aad o365group recyclebinitem restore --displayName "My Group"
42
+ ```
43
+
44
+ Restores the Microsoft 365 Group with specific mail nickname
45
+
46
+ ```sh
47
+ m365 aad o365group recyclebinitem restore --mailNickname "Mygroup"
48
+ ```
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
14
14
  : Name of the bucket to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--orderHint [orderHint]`
29
32
  : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
38
41
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
39
42
  ```
40
43
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
44
+ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
42
45
 
43
46
  ```sh
44
- m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
47
+ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
48
  ```
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
17
17
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
50
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
53
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
54
  ```
52
55
 
53
56
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
57
 
55
58
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
59
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
60
+ ```
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
11
11
  ## Options
12
12
 
13
13
  `--planId [planId]`
14
- : ID of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
14
+ : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
+
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
18
 
16
19
  `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
20
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
38
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
39
 
37
40
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
41
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
42
  ```
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
17
17
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--confirm`
32
35
  : Don't prompt for confirmation
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
59
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
60
 
58
61
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
62
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
63
  ```