@pnp/cli-microsoft365 4.2.0-beta.eca91f0 → 4.2.0

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 (43) hide show
  1. package/.devcontainer/Dockerfile +2 -2
  2. package/dist/appInsights.js +2 -0
  3. package/dist/cli/Cli.js +4 -1
  4. package/dist/m365/aad/commands/app/app-add.js +58 -5
  5. package/dist/m365/aad/commands/o365group/o365group-add.js +56 -50
  6. package/dist/m365/aad/commands/oauth2grant/oauth2grant-add.js +5 -8
  7. package/dist/m365/aad/commands/oauth2grant/oauth2grant-set.js +3 -3
  8. package/dist/m365/aad/commands/sp/sp-add.js +107 -0
  9. package/dist/m365/aad/commands.js +1 -0
  10. package/dist/m365/base/M365RcJson.js +3 -0
  11. package/dist/m365/file/commands/file-add.js +32 -13
  12. package/dist/m365/file/commands/file-list.js +181 -0
  13. package/dist/m365/file/commands.js +2 -1
  14. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.13.1.js +53 -0
  15. package/dist/m365/spfx/commands/project/project-upgrade.js +2 -1
  16. package/dist/m365/spfx/commands/spfx-doctor.js +176 -62
  17. package/dist/m365/spo/commands/contenttype/contenttype-list.js +52 -0
  18. package/dist/m365/spo/commands/list/list-get.js +6 -2
  19. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +90 -0
  20. package/dist/m365/spo/commands/page/Page.js +3 -1
  21. package/dist/m365/spo/commands/page/page-add.js +7 -10
  22. package/dist/m365/spo/commands/page/page-set.js +7 -10
  23. package/dist/m365/spo/commands/site/site-remove.js +98 -30
  24. package/dist/m365/spo/commands.js +3 -1
  25. package/dist/m365/teams/commands/report/report-directroutingcalls.js +1 -1
  26. package/dist/m365/teams/commands/report/report-pstncalls.js +1 -1
  27. package/docs/docs/cmd/aad/app/app-add.md +11 -0
  28. package/docs/docs/cmd/aad/o365group/o365group-add.md +1 -0
  29. package/docs/docs/cmd/aad/oauth2grant/oauth2grant-set.md +3 -2
  30. package/docs/docs/cmd/aad/sp/sp-add.md +53 -0
  31. package/docs/docs/cmd/file/file-add.md +11 -0
  32. package/docs/docs/cmd/file/file-list.md +46 -0
  33. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  34. package/docs/docs/cmd/spo/contenttype/contenttype-list.md +33 -0
  35. package/docs/docs/cmd/spo/list/list-get.md +9 -0
  36. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +39 -0
  37. package/docs/docs/cmd/spo/page/page-add.md +2 -2
  38. package/docs/docs/cmd/spo/page/page-set.md +3 -3
  39. package/docs/docs/cmd/spo/site/site-remove.md +3 -1
  40. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +0 -3
  41. package/docs/docs/cmd/teams/report/report-pstncalls.md +4 -3
  42. package/npm-shrinkwrap.json +508 -886
  43. package/package.json +19 -18
@@ -284,11 +284,11 @@ class SpoPageAddCommand extends SpoCommand_1.default {
284
284
  },
285
285
  {
286
286
  option: '-l, --layoutType [layoutType]',
287
- autocomplete: ['Article', 'Home']
287
+ autocomplete: Page_1.supportedPageLayouts
288
288
  },
289
289
  {
290
290
  option: '-p, --promoteAs [promoteAs]',
291
- autocomplete: ['HomePage', 'NewsPage', 'Template']
291
+ autocomplete: Page_1.supportedPromoteAs
292
292
  },
293
293
  {
294
294
  option: '--commentsEnabled'
@@ -312,20 +312,17 @@ class SpoPageAddCommand extends SpoCommand_1.default {
312
312
  return isValidSharePointUrl;
313
313
  }
314
314
  if (args.options.layoutType &&
315
- args.options.layoutType !== 'Article' &&
316
- args.options.layoutType !== 'Home') {
317
- return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
315
+ Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
316
+ return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
318
317
  }
319
318
  if (args.options.promoteAs &&
320
- args.options.promoteAs !== 'HomePage' &&
321
- args.options.promoteAs !== 'NewsPage' &&
322
- args.options.promoteAs !== 'Template') {
323
- return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
319
+ Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
320
+ return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
324
321
  }
325
322
  if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
326
323
  return 'You can only promote home pages as site home page';
327
324
  }
328
- if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
325
+ if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
329
326
  return 'You can only promote article pages as news article';
330
327
  }
331
328
  return true;
@@ -283,11 +283,11 @@ class SpoPageSetCommand extends SpoCommand_1.default {
283
283
  },
284
284
  {
285
285
  option: '-l, --layoutType [layoutType]',
286
- autocomplete: ['Article', 'Home']
286
+ autocomplete: Page_1.supportedPageLayouts
287
287
  },
288
288
  {
289
289
  option: '-p, --promoteAs [promoteAs]',
290
- autocomplete: ['HomePage', 'NewsPage', 'Template']
290
+ autocomplete: Page_1.supportedPromoteAs
291
291
  },
292
292
  {
293
293
  option: '--commentsEnabled [commentsEnabled]',
@@ -315,20 +315,17 @@ class SpoPageSetCommand extends SpoCommand_1.default {
315
315
  return isValidSharePointUrl;
316
316
  }
317
317
  if (args.options.layoutType &&
318
- args.options.layoutType !== 'Article' &&
319
- args.options.layoutType !== 'Home') {
320
- return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
318
+ Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
319
+ return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
321
320
  }
322
321
  if (args.options.promoteAs &&
323
- args.options.promoteAs !== 'HomePage' &&
324
- args.options.promoteAs !== 'NewsPage' &&
325
- args.options.promoteAs !== 'Template') {
326
- return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
322
+ Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
323
+ return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
327
324
  }
328
325
  if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
329
326
  return 'You can only promote home pages as site home page';
330
327
  }
331
- if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
328
+ if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
332
329
  return 'You can only promote article pages as news article';
333
330
  }
334
331
  if (typeof args.options.commentsEnabled !== 'undefined' &&
@@ -25,26 +25,65 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
25
25
  commandAction(logger, args, cb) {
26
26
  const removeSite = () => {
27
27
  this.dots = '';
28
- this
29
- .getSiteGroupId(args.options.url, logger)
30
- .then((_groupId) => {
31
- if (_groupId === '00000000-0000-0000-0000-000000000000') {
32
- if (this.debug) {
33
- logger.logToStderr('Site is not groupified. Going ahead with the conventional site deletion options');
34
- }
35
- return this.deleteSiteWithoutGroup(logger, args);
36
- }
37
- else {
38
- if (this.debug) {
39
- logger.logToStderr(`Site attached to group ${_groupId}. Initiating group delete operation via Graph API`);
28
+ if (args.options.fromRecycleBin) {
29
+ this
30
+ .deleteSiteWithoutGroup(logger, args)
31
+ .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
32
+ }
33
+ else {
34
+ this
35
+ .getSiteGroupId(args.options.url, logger)
36
+ .then((groupId) => {
37
+ if (groupId === '00000000-0000-0000-0000-000000000000') {
38
+ if (this.debug) {
39
+ logger.logToStderr('Site is not groupified. Going ahead with the conventional site deletion options');
40
+ }
41
+ return this.deleteSiteWithoutGroup(logger, args);
40
42
  }
41
- if (args.options.fromRecycleBin || args.options.skipRecycleBin || args.options.wait) {
42
- logger.log(chalk.yellow(`Entered site is a groupified site. Hence, the parameters 'fromRecycleBin' or 'skipRecycleBin' or 'wait' will not be applicable.`));
43
+ else {
44
+ if (this.debug) {
45
+ logger.logToStderr(`Site attached to group ${groupId}. Initiating group delete operation via Graph API`);
46
+ }
47
+ return this
48
+ .getSiteGroup(groupId)
49
+ .then((group) => {
50
+ if (args.options.skipRecycleBin || args.options.wait) {
51
+ logger.logToStderr(chalk.yellow(`Entered site is a groupified site. Hence, the parameters 'skipRecycleBin' and 'wait' will not be applicable.`));
52
+ }
53
+ return this.deleteGroupifiedSite(group.id, logger);
54
+ })
55
+ .catch((err) => {
56
+ if (err.response.status === 404) {
57
+ if (this.verbose) {
58
+ logger.logToStderr(`Site group doesn't exist. Searching in the Microsoft 365 deleted groups.`);
59
+ }
60
+ return this
61
+ .isSiteGroupDeleted(groupId)
62
+ .then((deletedGroups) => {
63
+ if (deletedGroups.value.length === 0) {
64
+ if (this.verbose) {
65
+ logger.logToStderr("Site group doesn't exist anymore. Deleting the site.");
66
+ }
67
+ if (args.options.wait) {
68
+ logger.logToStderr(chalk.yellow(`Entered site is a groupified site. Hence, the parameter 'wait' will not be applicable.`));
69
+ }
70
+ return Promise.resolve();
71
+ }
72
+ else {
73
+ return Promise.reject(`Site group still exists in the deleted groups. The site won't be removed.`);
74
+ }
75
+ })
76
+ .then(_ => this.deleteOrphanedSite(logger, args.options.url))
77
+ .catch((err) => Promise.reject(err));
78
+ }
79
+ else {
80
+ return Promise.reject(err);
81
+ }
82
+ });
43
83
  }
44
- return this.deleteGroupifiedSite(_groupId, logger);
45
- }
46
- })
47
- .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
84
+ })
85
+ .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
86
+ }
48
87
  };
49
88
  if (args.options.confirm) {
50
89
  removeSite();
@@ -65,32 +104,64 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
65
104
  });
66
105
  }
67
106
  }
107
+ getSiteGroup(groupId) {
108
+ const requestOptions = {
109
+ url: `https://graph.microsoft.com/v1.0/groups/${groupId}`,
110
+ headers: {
111
+ accept: 'application/json;odata.metadata=none'
112
+ },
113
+ responseType: 'json'
114
+ };
115
+ return request_1.default.get(requestOptions);
116
+ }
117
+ isSiteGroupDeleted(groupId) {
118
+ const requestOptions = {
119
+ url: `https://graph.microsoft.com/v1.0/directory/deletedItems/Microsoft.Graph.Group?$select=id&$filter=groupTypes/any(c:c+eq+'Unified') and startswith(id, '${groupId}')`,
120
+ headers: {
121
+ accept: 'application/json;odata.metadata=none'
122
+ },
123
+ responseType: 'json'
124
+ };
125
+ return request_1.default.get(requestOptions);
126
+ }
127
+ deleteOrphanedSite(logger, url) {
128
+ return this
129
+ .getSpoAdminUrl(logger, this.debug)
130
+ .then((spoAdminUrl) => {
131
+ const requestOptions = {
132
+ url: `${spoAdminUrl}/_api/GroupSiteManager/Delete?siteUrl='${url}'`,
133
+ headers: {
134
+ 'content-type': 'application/json;odata=nometadata',
135
+ accept: 'application/json;odata=nometadata'
136
+ },
137
+ responseType: 'json'
138
+ };
139
+ return request_1.default.post(requestOptions);
140
+ });
141
+ }
68
142
  deleteSiteWithoutGroup(logger, args) {
69
143
  return this
70
144
  .getSpoAdminUrl(logger, this.debug)
71
- .then((_spoAdminUrl) => {
72
- this.spoAdminUrl = _spoAdminUrl;
145
+ .then((spoAdminUrl) => {
146
+ this.spoAdminUrl = spoAdminUrl;
73
147
  return this.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
74
148
  })
75
149
  .then((res) => {
76
150
  this.context = res;
77
151
  if (args.options.fromRecycleBin) {
78
152
  if (this.verbose) {
79
- logger.logToStderr(`Deleting site collection from recycle bin ${args.options.url}...`);
153
+ logger.logToStderr(`Deleting site from recycle bin ${args.options.url}...`);
80
154
  }
81
155
  return this.deleteSiteFromTheRecycleBin(args.options.url, args.options.wait, logger);
82
156
  }
83
157
  else {
84
- if (this.verbose) {
85
- logger.logToStderr(`Deleting site collection ${args.options.url}...`);
86
- }
87
158
  return this.deleteSite(args.options.url, args.options.wait, logger);
88
159
  }
89
160
  })
90
161
  .then(() => {
91
162
  if (args.options.skipRecycleBin) {
92
163
  if (this.verbose) {
93
- logger.logToStderr(`Also deleting site collection from recycle bin ${args.options.url}...`);
164
+ logger.logToStderr(`Also deleting site from tenant recycle bin ${args.options.url}...`);
94
165
  }
95
166
  return this.deleteSiteFromTheRecycleBin(args.options.url, args.options.wait, logger);
96
167
  }
@@ -106,7 +177,7 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
106
177
  .then((res) => {
107
178
  this.context = res;
108
179
  if (this.verbose) {
109
- logger.logToStderr(`Deleting site ${url} ...`);
180
+ logger.logToStderr(`Deleting site ${url}...`);
110
181
  }
111
182
  const requestOptions = {
112
183
  url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
@@ -143,9 +214,6 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
143
214
  .ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug)
144
215
  .then((res) => {
145
216
  this.context = res;
146
- if (this.verbose) {
147
- logger.logToStderr(`Deleting site ${url} from the recycle bin...`);
148
- }
149
217
  const requestOptions = {
150
218
  url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
151
219
  headers: {
@@ -185,7 +253,7 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
185
253
  .then((res) => {
186
254
  this.context = res;
187
255
  if (this.verbose) {
188
- logger.logToStderr(`Retrieving the GroupId of the site ${url}`);
256
+ logger.logToStderr(`Retrieving the group Id of the site ${url}`);
189
257
  }
190
258
  const requestOptions = {
191
259
  url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
@@ -22,9 +22,10 @@ exports.default = {
22
22
  CDN_POLICY_SET: `${prefix} cdn policy set`,
23
23
  CDN_SET: `${prefix} cdn set`,
24
24
  CONTENTTYPE_ADD: `${prefix} contenttype add`,
25
- CONTENTTYPE_GET: `${prefix} contenttype get`,
26
25
  CONTENTTYPE_FIELD_REMOVE: `${prefix} contenttype field remove`,
27
26
  CONTENTTYPE_FIELD_SET: `${prefix} contenttype field set`,
27
+ CONTENTTYPE_GET: `${prefix} contenttype get`,
28
+ CONTENTTYPE_LIST: `${prefix} contenttype list`,
28
29
  CONTENTTYPE_REMOVE: `${prefix} contenttype remove`,
29
30
  CONTENTTYPEHUB_GET: `${prefix} contenttypehub get`,
30
31
  CUSTOMACTION_ADD: `${prefix} customaction add`,
@@ -107,6 +108,7 @@ exports.default = {
107
108
  LIST_WEBHOOK_REMOVE: `${prefix} list webhook remove`,
108
109
  LIST_WEBHOOK_SET: `${prefix} list webhook set`,
109
110
  LISTITEM_ADD: `${prefix} listitem add`,
111
+ LISTITEM_ATTACHMENT_LIST: `${prefix} listitem attachment list`,
110
112
  LISTITEM_GET: `${prefix} listitem get`,
111
113
  LISTITEM_ISRECORD: `${prefix} listitem isrecord`,
112
114
  LISTITEM_LIST: `${prefix} listitem list`,
@@ -22,7 +22,7 @@ class TeamsReportDirectroutingcallsCommand extends GraphCommand_1.default {
22
22
  commandAction(logger, args, cb) {
23
23
  const toDateTimeParameter = encodeURIComponent(args.options.toDateTime ? args.options.toDateTime : new Date().toISOString());
24
24
  const requestOptions = {
25
- url: `${this.resource}/beta/communications/callRecords/getDirectRoutingCalls(fromDateTime=${encodeURIComponent(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
25
+ url: `${this.resource}/v1.0/communications/callRecords/getDirectRoutingCalls(fromDateTime=${encodeURIComponent(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
26
26
  headers: {
27
27
  accept: 'application/json;odata.metadata=none'
28
28
  },
@@ -22,7 +22,7 @@ class TeamsReportPstncallsCommand extends GraphCommand_1.default {
22
22
  commandAction(logger, args, cb) {
23
23
  const toDateTimeParameter = encodeURIComponent(args.options.toDateTime ? args.options.toDateTime : new Date().toISOString());
24
24
  const requestOptions = {
25
- url: `${this.resource}/beta/communications/callRecords/getPstnCalls(fromDateTime=${encodeURIComponent(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
25
+ url: `${this.resource}/v1.0/communications/callRecords/getPstnCalls(fromDateTime=${encodeURIComponent(args.options.fromDateTime)},toDateTime=${toDateTimeParameter})`,
26
26
  headers: {
27
27
  accept: 'application/json;odata.metadata=none'
28
28
  },
@@ -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
+ ```
@@ -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
 
@@ -22,7 +22,7 @@ m365 aad oauth2grant set [options]
22
22
 
23
23
  Before you can update service principal's OAuth2 permissions, you need to get the `objectId` of the permissions grant to update. You can retrieve it using the [aad oauth2grant list](./oauth2grant-list.md) command.
24
24
 
25
- If the `objectId` listed when using the [aad oauth2grant list](./oauth2grant-list.md) command has a minus sign ('-') prefix, you may receive an error indicating `--grantId` is missing. To resolve this issue simply escape the leading '-'.
25
+ If the `objectId` listed when using the [aad oauth2grant list](./oauth2grant-list.md) command has a minus sign ('-') prefix, you may receive an error indicating `--grantId` is missing. To resolve this issue simply escape the leading '-'.
26
26
 
27
27
  ```sh
28
28
  m365 aad oauth2grant set --grantId \\-Zc1JRY8REeLxmXz5KtixAYU3Q6noCBPlhwGiX7pxmU
@@ -38,4 +38,5 @@ m365 aad oauth2grant set --grantId YgA60KYa4UOPSdc-lpxYEnQkr8KVLDpCsOXkiV8i-ek -
38
38
 
39
39
  ## More information
40
40
 
41
- - Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
41
+ - Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
42
+ - Update a delegated permission grant (oAuth2PermissionGrant): [https://docs.microsoft.com/en-us/graph/api/oauth2permissiongrant-update?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/oauth2permissiongrant-update?view=graph-rest-1.0)
@@ -0,0 +1,53 @@
1
+ # aad sp add
2
+
3
+ Adds a service principal to a registered Azure AD app
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad sp add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--appId [appId]`
14
+ : ID of the application to which the service principal should be added
15
+
16
+ `--appName [appName]`
17
+ : Display name of the application to which the service principal should be added
18
+
19
+ `--objectId [objectId]`
20
+ : ObjectId of the application to which the service principal should be added
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ Specify either the `appId`, `appName` or `objectId`. If you specify more than one option value, the command will fail with an error.
27
+
28
+ If you register an application in the portal, an application object as well as a service principal object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the service principal separately. To register/create an application using the CLI for Microsoft 365, use the [m365 aad app add](../app/app-add.md) command.
29
+
30
+ ## Examples
31
+
32
+ Adds a service principal to a registered Azure AD app with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
33
+
34
+ ```sh
35
+ m365 aad sp add --appId b2307a39-e878-458b-bc90-03bc578531d6
36
+ ```
37
+
38
+ Adds a service principal to a registered Azure AD app with appName _Microsoft Graph_.
39
+
40
+ ```sh
41
+ m365 aad sp add --appName "Microsoft Graph"
42
+ ```
43
+
44
+ Adds a service principal to a registered Azure AD app with objectId _b2307a39-e878-458b-bc90-03bc578531d6_.
45
+
46
+ ```sh
47
+ m365 aad sp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
48
+ ```
49
+
50
+ ## More information
51
+
52
+ - Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
53
+ - Create servicePrincipal: [https://docs.microsoft.com/en-us/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0)
@@ -16,12 +16,17 @@ m365 file add [options]
16
16
  `-p, --filePath <filePath>`
17
17
  : Local path to the file to upload
18
18
 
19
+ `--siteUrl [siteUrl]`
20
+ : URL of the site to which upload the file. Specify to suppress lookup.
21
+
19
22
  --8<-- "docs/cmd/_global.md"
20
23
 
21
24
  ## Remarks
22
25
 
23
26
  The `folderUrl` must be an absolute URL to the document library where the file should be uploaded. The document library can be located in any site collection in your tenant, including OneDrive for Business. The `folderUrl` can also point to a (sub)folder in the document library.
24
27
 
28
+ By default, the `file add` command will automatically lookup the ID of the site where you want to upload the file based on the specified `folderUrl`. It will do this, by breaking the URL into chunks and incrementally calling Microsoft Graph to retrieve site information. This is necessary, because there is no other way looking at the URL to distinguish where the site URL ends and the document library URL starts. If you want to speed up uploading files, or you use resource-specific consent and your Azure AD app only has access to the specific site, you can use the `siteUrl` option to specify the URL of the site yourself.
29
+
25
30
  ## Examples
26
31
 
27
32
  Uploads file from the current folder to the root folder of a document library in the root site collection
@@ -47,3 +52,9 @@ Uploads file from the current folder to a document library in a non-root site co
47
52
  ```sh
48
53
  m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents"
49
54
  ```
55
+
56
+ Uploads file from the current folder to a document library in the specified site
57
+
58
+ ```sh
59
+ m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents" --siteUrl "https://contoso.sharepoint.com/sites/Contoso"
60
+ ```
@@ -0,0 +1,46 @@
1
+ # file list
2
+
3
+ Retrieves files from the specified folder and site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 file list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the folder from which to retrieve files is located
15
+
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the folder from which to retrieve files
18
+
19
+ `--recursive`
20
+ : Set to retrieve files from subfolders
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ This command is an improved version of the `spo file list` command. The main difference between the two commands is, that `file list` uses Microsoft Graph and properly supports retrieving files from large folders. Because `file list` uses Microsoft Graph and `spo file list` uses SharePoint REST APIs, the data returned by both commands is different.
27
+
28
+ ## Examples
29
+
30
+ Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
31
+
32
+ ```sh
33
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
34
+ ```
35
+
36
+ Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
37
+
38
+ ```sh
39
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
40
+ ```
41
+
42
+ Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
43
+
44
+ ```sh
45
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
46
+ ```
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.0).
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.1).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -0,0 +1,33 @@
1
+ # spo contenttype list
2
+
3
+ Lists content types from specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo contenttype list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site for which to list content types
15
+
16
+ `-c, --category [category]`
17
+ : Category name of content types. When defined will return only content types from specified category
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve site content types
24
+
25
+ ```PowerShell
26
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
27
+ ```
28
+
29
+ Retrieve site content types from the 'List Content Types' category
30
+
31
+ ```PowerShell
32
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
33
+ ```
@@ -22,6 +22,9 @@ m365 spo list get [options]
22
22
  `-p, --properties [properties]`
23
23
  : Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
24
24
 
25
+ `--withPermissions`
26
+ : Set if you want to return associated roles and permissions of the list.
27
+
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Examples
@@ -44,6 +47,12 @@ Get information about a list returning the specified list properties
44
47
  m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Id,HasUniqueRoleAssignments,AllowContentTypes"
45
48
  ```
46
49
 
50
+ Get information about a list along with the roles and permissions
51
+
52
+ ```sh
53
+ m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions
54
+ ```
55
+
47
56
  ## More information
48
57
 
49
58
  - List REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint](https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint)
@@ -0,0 +1,39 @@
1
+ # spo listitem attachment list
2
+
3
+ Gets the attachments associated to a list item
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo listitem attachment list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ URL of the site from which the item should be retrieved
15
+
16
+ `--listId [listId]`
17
+ : ID of the list from which to retrieve the item. Specify listId or listTitle but not both
18
+
19
+ `--listTitle [listTitle]`
20
+ : Title of the list from which to retrieve the item. Specify listId or listTitle but not both
21
+
22
+ `--itemId <itemId>`
23
+ ID of the list item to in question
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Examples
28
+
29
+ Gets the attachments from list item with itemId _147_ in list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
30
+
31
+ ```sh
32
+ m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --itemId 147
33
+ ```
34
+
35
+ Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-afce-4e55-b836-fce03286cccf_ in site _https://contoso.sharepoint.com/sites/project-x_
36
+
37
+ ```sh
38
+ m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
39
+ ```
@@ -20,10 +20,10 @@ m365 spo page add [options]
20
20
  : Title of the page to create. If not specified, will use the page name as its title
21
21
 
22
22
  `-l, --layoutType [layoutType]`
23
- : Layout of the page. Allowed values `Article,Home`. Default `Article`
23
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`
24
24
 
25
25
  `-p, --promoteAs [promoteAs]`
26
- : Create the page for a specific purpose. Allowed values `HomePage,NewsPage`
26
+ : Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`
27
27
 
28
28
  `--commentsEnabled`
29
29
  : Set to enable comments on the page
@@ -17,13 +17,13 @@ m365 spo page set [options]
17
17
  : URL of the site where the page to update is located
18
18
 
19
19
  `-l, --layoutType [layoutType]`
20
- : Layout of the page. Allowed values `Article,Home`
20
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`
21
21
 
22
22
  `-p, --promoteAs [promoteAs]`
23
- : Update the page purpose. Allowed values `HomePage,NewsPage`
23
+ : Update the page purpose. Allowed values `HomePage`, `NewsPage`
24
24
 
25
25
  `--commentsEnabled [commentsEnabled]`
26
- : Set to `true`, to enable comments on the page. Allowed values `true,false`
26
+ : Set to `true`, to enable comments on the page. Allowed values `true`, `false`
27
27
 
28
28
  `--publish`
29
29
  : Set to publish the page
@@ -34,7 +34,9 @@ m365 spo site remove [options]
34
34
 
35
35
  Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
36
36
 
37
- If the site which you have selected to remove is groupified (Modern Team Site), flags `--fromRecycleBin`, `--skipRecycleBin` and `--wait` will not be applicable
37
+ If the site which you have selected to remove is groupified (Modern Team Site) and group exists, flags `--skipRecycleBin` and `--wait` will not be applicable. If the linked group still exists in the deleted groups, the site won't be removed. If the linked group is permanently deleted, the site will be removed like any classic site (except that flag `--wait` only will still not be applicable).
38
+
39
+ If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
38
40
 
39
41
  ## Examples
40
42