@pnp/cli-microsoft365 10.4.0-beta.791a39c → 10.4.0-beta.b552c1b
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.
- package/.eslintrc.cjs +3 -1
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/appInsights.js +1 -1
- package/dist/cli/cli.js +10 -2
- package/dist/config.js +1 -1
- package/dist/m365/entra/commands/group/group-member-add.js +12 -6
- package/dist/m365/entra/commands/group/group-member-set.js +12 -6
- package/dist/m365/entra/commands/user/user-session-revoke.js +70 -0
- package/dist/m365/entra/commands.js +1 -0
- package/dist/m365/outlook/commands/mailbox/mailbox-settings-get.js +71 -0
- package/dist/m365/outlook/commands/mailbox/mailbox-settings-set.js +5 -2
- package/dist/m365/outlook/commands.js +1 -0
- package/dist/m365/spo/commands/field/field-get.js +6 -3
- package/dist/m365/spo/commands/field/field-remove.js +10 -8
- package/dist/m365/spo/commands/field/field-set.js +6 -2
- package/dist/m365/spo/commands/mail/mail-send.js +2 -0
- package/dist/m365/spo/commands/page/clientsidepages.js +101 -9
- package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -1
- package/dist/m365/spo/commands/page/page-text-add.js +7 -1
- package/docs/docs/cmd/entra/group/group-member-add.mdx +17 -2
- package/docs/docs/cmd/entra/group/group-member-set.mdx +17 -2
- package/docs/docs/cmd/entra/user/user-session-revoke.mdx +65 -0
- package/docs/docs/cmd/outlook/mailbox/mailbox-settings-get.mdx +131 -0
- package/docs/docs/cmd/spo/field/field-get.mdx +12 -2
- package/docs/docs/cmd/spo/field/field-remove.mdx +12 -3
- package/docs/docs/cmd/spo/field/field-set.mdx +17 -3
- package/npm-shrinkwrap.json +568 -1139
- package/package.json +13 -13
|
@@ -271,6 +271,12 @@ export class ClientSidePage {
|
|
|
271
271
|
for (let i = 0; i < this.sections.length; i++) {
|
|
272
272
|
html.push(this.sections[i].toHtml());
|
|
273
273
|
}
|
|
274
|
+
if (this.pageSettings) {
|
|
275
|
+
html.push(this.pageSettings.toHtml());
|
|
276
|
+
}
|
|
277
|
+
if (this.backgroundSettings) {
|
|
278
|
+
html.push(this.backgroundSettings.toHtml());
|
|
279
|
+
}
|
|
274
280
|
html.push("</div>");
|
|
275
281
|
return html.join("");
|
|
276
282
|
}
|
|
@@ -286,17 +292,23 @@ export class ClientSidePage {
|
|
|
286
292
|
// gather our controls from the supplied html
|
|
287
293
|
getBoundedDivMarkup(html, /<div\b[^>]*data-sp-canvascontrol[^>]*?>/i, markup => {
|
|
288
294
|
// get the control type
|
|
289
|
-
const ct = /controlType":(\d*?)
|
|
295
|
+
const ct = /controlType":(\d*?)(,|&)/i.exec(markup);
|
|
290
296
|
// if no control type is present this is a column which we give type 0 to let us process it
|
|
291
|
-
const controlType = ct == null || ct.length <
|
|
297
|
+
const controlType = ct == null || ct.length < 0 ? -1 : parseInt(ct[1], 10);
|
|
292
298
|
let control = null;
|
|
293
299
|
switch (controlType) {
|
|
294
|
-
case
|
|
300
|
+
case -1:
|
|
295
301
|
// empty canvas column
|
|
296
302
|
control = new CanvasColumn(null, 0);
|
|
297
303
|
control.fromHtml(markup);
|
|
298
304
|
page.mergeColumnToTree(control);
|
|
299
305
|
break;
|
|
306
|
+
case 0:
|
|
307
|
+
// page settings
|
|
308
|
+
control = new PageSettings();
|
|
309
|
+
control.fromHtml(markup);
|
|
310
|
+
page.pageSettings = control;
|
|
311
|
+
break;
|
|
300
312
|
case 3:
|
|
301
313
|
// client side webpart
|
|
302
314
|
control = new ClientSideWebpart("");
|
|
@@ -309,6 +321,12 @@ export class ClientSidePage {
|
|
|
309
321
|
control.fromHtml(markup);
|
|
310
322
|
page.mergePartToTree(control);
|
|
311
323
|
break;
|
|
324
|
+
case 14:
|
|
325
|
+
// backgroundSection
|
|
326
|
+
control = new BackgroundSettings();
|
|
327
|
+
control.fromHtml(markup);
|
|
328
|
+
page.backgroundSettings = control;
|
|
329
|
+
break;
|
|
312
330
|
}
|
|
313
331
|
});
|
|
314
332
|
// refresh all the orders within the tree
|
|
@@ -364,7 +382,7 @@ export class ClientSidePage {
|
|
|
364
382
|
}
|
|
365
383
|
const sections = this.sections.filter(s => s.order === zoneIndex);
|
|
366
384
|
if (sections.length < 1) {
|
|
367
|
-
section = new CanvasSection(this, zoneIndex);
|
|
385
|
+
section = new CanvasSection(this, zoneIndex, [], control?.controlData?.position.zoneId, control.controlData?.zoneGroupMetadata);
|
|
368
386
|
this.sections.push(section);
|
|
369
387
|
}
|
|
370
388
|
else {
|
|
@@ -392,7 +410,7 @@ export class ClientSidePage {
|
|
|
392
410
|
let section = null;
|
|
393
411
|
const sections = this.sections.filter(s => s.order === order);
|
|
394
412
|
if (sections.length < 1) {
|
|
395
|
-
section = new CanvasSection(this, order);
|
|
413
|
+
section = new CanvasSection(this, order, [], column.controlData?.position?.zoneId, column.controlData?.zoneGroupMetadata);
|
|
396
414
|
this.sections.push(section);
|
|
397
415
|
}
|
|
398
416
|
else {
|
|
@@ -403,10 +421,12 @@ export class ClientSidePage {
|
|
|
403
421
|
}
|
|
404
422
|
}
|
|
405
423
|
export class CanvasSection {
|
|
406
|
-
constructor(page, order, columns = []) {
|
|
424
|
+
constructor(page, order, columns = [], zoneId, zoneGroupMetadata) {
|
|
407
425
|
this.page = page;
|
|
408
426
|
this.order = order;
|
|
409
427
|
this.columns = columns;
|
|
428
|
+
this.zoneId = zoneId;
|
|
429
|
+
this.zoneGroupMetadata = zoneGroupMetadata;
|
|
410
430
|
}
|
|
411
431
|
/**
|
|
412
432
|
* Default column (this.columns[0]) for this section
|
|
@@ -457,6 +477,20 @@ class CanvasControl {
|
|
|
457
477
|
this.id = this.controlData.id;
|
|
458
478
|
}
|
|
459
479
|
}
|
|
480
|
+
export class PageSettings extends CanvasControl {
|
|
481
|
+
constructor() {
|
|
482
|
+
super(0, "1.0");
|
|
483
|
+
}
|
|
484
|
+
getControlData() {
|
|
485
|
+
return this.controlData;
|
|
486
|
+
}
|
|
487
|
+
toHtml() {
|
|
488
|
+
return `<div data-sp-canvascontrol="" data-sp-canvasdataversion="${this.dataVersion}" data-sp-controldata="${this.jsonData}"></div>`;
|
|
489
|
+
}
|
|
490
|
+
fromHtml(html) {
|
|
491
|
+
super.fromHtml(html);
|
|
492
|
+
}
|
|
493
|
+
}
|
|
460
494
|
export class CanvasColumn extends CanvasControl {
|
|
461
495
|
constructor(section, order, factor = 12, controls = [], dataVersion = "1.0") {
|
|
462
496
|
super(0, dataVersion);
|
|
@@ -513,8 +547,10 @@ export class CanvasColumn extends CanvasControl {
|
|
|
513
547
|
position: {
|
|
514
548
|
sectionFactor: this.factor,
|
|
515
549
|
sectionIndex: this.order,
|
|
516
|
-
zoneIndex: this.section ? this.section.order : 0
|
|
550
|
+
zoneIndex: this.section ? this.section.order : 0,
|
|
551
|
+
zoneId: this.section?.zoneId
|
|
517
552
|
},
|
|
553
|
+
zoneGroupMetadata: this.section?.zoneGroupMetadata,
|
|
518
554
|
};
|
|
519
555
|
}
|
|
520
556
|
/**
|
|
@@ -543,6 +579,58 @@ export class ClientSidePart extends CanvasControl {
|
|
|
543
579
|
}
|
|
544
580
|
}
|
|
545
581
|
}
|
|
582
|
+
export class BackgroundSettings extends ClientSidePart {
|
|
583
|
+
constructor() {
|
|
584
|
+
super(0, "1.0");
|
|
585
|
+
this.propertieJson = {};
|
|
586
|
+
this.serverProcessedContent = null;
|
|
587
|
+
}
|
|
588
|
+
getControlData() {
|
|
589
|
+
return {
|
|
590
|
+
controlType: this.controlType
|
|
591
|
+
};
|
|
592
|
+
}
|
|
593
|
+
toHtml() {
|
|
594
|
+
// will form the value of the data-sp-webpartdata attribute
|
|
595
|
+
const data = {
|
|
596
|
+
dataVersion: this.dataVersion,
|
|
597
|
+
instanceId: this.id,
|
|
598
|
+
properties: this.propertieJson,
|
|
599
|
+
serverProcessedContent: this.serverProcessedContent,
|
|
600
|
+
};
|
|
601
|
+
const html = [];
|
|
602
|
+
html.push(`<div data-sp-canvascontrol="" data-sp-canvasdataversion="${this.dataVersion}" data-sp-controldata="${this.jsonData}">`);
|
|
603
|
+
html.push(`<div data-sp-webpart="" data-sp-webpartdataversion="${this.dataVersion}" data-sp-webpartdata="${ClientSidePage.jsonToEscapedString(data)}">`);
|
|
604
|
+
html.push(`<div data-sp-componentid="">`);
|
|
605
|
+
html.push("</div>");
|
|
606
|
+
html.push(`<div data-sp-htmlproperties="">`);
|
|
607
|
+
for (let imageSource in this.serverProcessedContent?.imageSources) {
|
|
608
|
+
html.push(`<img data-sp-prop-name="${imageSource}" src="${this.serverProcessedContent?.imageSources[imageSource]}" />`);
|
|
609
|
+
}
|
|
610
|
+
html.push("</div>");
|
|
611
|
+
html.push("</div>");
|
|
612
|
+
html.push("</div>");
|
|
613
|
+
return html.join("");
|
|
614
|
+
}
|
|
615
|
+
setProperties(properties) {
|
|
616
|
+
this.propertieJson = extend(this.propertieJson, properties);
|
|
617
|
+
return this;
|
|
618
|
+
}
|
|
619
|
+
fromHtml(html) {
|
|
620
|
+
super.fromHtml(html);
|
|
621
|
+
const webPartData = ClientSidePage.escapedStringToJson(getAttrValueFromString(html, "data-sp-webpartdata"));
|
|
622
|
+
this.setProperties(webPartData.properties);
|
|
623
|
+
if (typeof webPartData.serverProcessedContent !== "undefined") {
|
|
624
|
+
this.serverProcessedContent = webPartData.serverProcessedContent;
|
|
625
|
+
}
|
|
626
|
+
if (typeof webPartData.dynamicDataPaths !== "undefined") {
|
|
627
|
+
this.dynamicDataPaths = webPartData.dynamicDataPaths;
|
|
628
|
+
}
|
|
629
|
+
if (typeof webPartData.dynamicDataValues !== "undefined") {
|
|
630
|
+
this.dynamicDataValues = webPartData.dynamicDataValues;
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
}
|
|
546
634
|
export class ClientSideText extends ClientSidePart {
|
|
547
635
|
constructor(text = "") {
|
|
548
636
|
super(4, "1.0");
|
|
@@ -570,8 +658,10 @@ export class ClientSideText extends ClientSidePart {
|
|
|
570
658
|
controlIndex: this.order,
|
|
571
659
|
sectionFactor: this.column ? this.column.factor : 0,
|
|
572
660
|
sectionIndex: this.column ? this.column.order : 0,
|
|
573
|
-
zoneIndex: this.column && this.column.section ? this.column.section.order : 0
|
|
661
|
+
zoneIndex: this.column && this.column.section ? this.column.section.order : 0,
|
|
662
|
+
zoneId: this.column?.section?.zoneId
|
|
574
663
|
},
|
|
664
|
+
zoneGroupMetadata: this.column?.section?.zoneGroupMetadata,
|
|
575
665
|
};
|
|
576
666
|
}
|
|
577
667
|
toHtml(index) {
|
|
@@ -684,9 +774,11 @@ export class ClientSideWebpart extends ClientSidePart {
|
|
|
684
774
|
controlIndex: this.order,
|
|
685
775
|
sectionFactor: this.column ? this.column.factor : 0,
|
|
686
776
|
sectionIndex: this.column ? this.column.order : 0,
|
|
687
|
-
zoneIndex: this.column && this.column.section ? this.column.section.order : 0
|
|
777
|
+
zoneIndex: this.column && this.column.section ? this.column.section.order : 0,
|
|
778
|
+
zoneId: this.column?.section?.zoneId
|
|
688
779
|
},
|
|
689
780
|
webPartId: this.webPartId,
|
|
781
|
+
zoneGroupMetadata: this.column?.section?.zoneGroupMetadata,
|
|
690
782
|
};
|
|
691
783
|
}
|
|
692
784
|
renderHtmlProperties() {
|
|
@@ -132,7 +132,8 @@ class SpoPageClientSideWebPartAddCommand extends SpoCommand {
|
|
|
132
132
|
id: webPart.id,
|
|
133
133
|
position: Object.assign({}, control.position),
|
|
134
134
|
webPartId: webPart.webPartId,
|
|
135
|
-
emphasis: {}
|
|
135
|
+
emphasis: {},
|
|
136
|
+
zoneGroupMetadata: control.zoneGroupMetadata
|
|
136
137
|
}, webPart);
|
|
137
138
|
if (!control.controlType) {
|
|
138
139
|
// it's an empty column so we need to replace it with the web part
|
|
@@ -10,7 +10,7 @@ import { urlUtil } from '../../../../utils/urlUtil.js';
|
|
|
10
10
|
import { validation } from '../../../../utils/validation.js';
|
|
11
11
|
import SpoCommand from '../../../base/SpoCommand.js';
|
|
12
12
|
import commands from '../../commands.js';
|
|
13
|
-
import { ClientSideText } from './clientsidepages.js';
|
|
13
|
+
import { CanvasSection, ClientSideText } from './clientsidepages.js';
|
|
14
14
|
import { Page } from './Page.js';
|
|
15
15
|
class SpoPageTextAddCommand extends SpoCommand {
|
|
16
16
|
get name() {
|
|
@@ -46,6 +46,12 @@ class SpoPageTextAddCommand extends SpoCommand {
|
|
|
46
46
|
const page = await Page.getPage(pageName, args.options.webUrl, logger, this.debug, this.verbose);
|
|
47
47
|
const section = (args.options.section || 1) - 1;
|
|
48
48
|
const column = (args.options.column || 1) - 1;
|
|
49
|
+
// Add a new section when page does not contain any sections
|
|
50
|
+
if (page.sections.length < 1) {
|
|
51
|
+
const newSection = new CanvasSection(page, 1);
|
|
52
|
+
newSection.defaultColumn;
|
|
53
|
+
page.sections.push(newSection);
|
|
54
|
+
}
|
|
49
55
|
// Make sure the section is in range
|
|
50
56
|
if (section >= page.sections.length) {
|
|
51
57
|
throw new Error(`Invalid section '${section + 1}'`);
|
|
@@ -14,10 +14,13 @@ m365 entra group member add [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-i, --groupId [groupId]`
|
|
17
|
-
: The ID of the Microsoft Entra group. Specify `groupId` or `
|
|
17
|
+
: The ID of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
18
18
|
|
|
19
19
|
`-n, --groupDisplayName [groupDisplayName]`
|
|
20
|
-
: The display name of the Microsoft Entra group. Specify `groupId` or `
|
|
20
|
+
: (deprecated. Use option `groupName` instead) The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
21
|
+
|
|
22
|
+
`--groupName [groupName]`
|
|
23
|
+
: The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
21
24
|
|
|
22
25
|
`--ids [ids]`
|
|
23
26
|
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
|
|
@@ -39,6 +42,12 @@ Add a single member specified by ID as a member to a group specified by display
|
|
|
39
42
|
m365 entra group member add --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
|
|
40
43
|
```
|
|
41
44
|
|
|
45
|
+
Add a single member specified by ID as a member to a group specified by group name.
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 entra group member add --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
|
|
49
|
+
```
|
|
50
|
+
|
|
42
51
|
Add multiple members specified by ID as members to a group specified by ID.
|
|
43
52
|
|
|
44
53
|
```sh
|
|
@@ -51,6 +60,12 @@ Add a single member specified by UPN as an owner to a group specified by display
|
|
|
51
60
|
m365 entra group member add --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
|
|
52
61
|
```
|
|
53
62
|
|
|
63
|
+
Add a single member specified by UPN as an owner to a group specified by group name.
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 entra group member add --groupName Developers --userNames john.doe@contoso.com --role Owner
|
|
67
|
+
```
|
|
68
|
+
|
|
54
69
|
Adds multiple members specified by UPN as owners to a group specified by ID.
|
|
55
70
|
|
|
56
71
|
```sh
|
|
@@ -14,10 +14,13 @@ m365 entra group member set [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-i, --groupId [groupId]`
|
|
17
|
-
: The ID of the Entra ID group. Specify `groupId` or `
|
|
17
|
+
: The ID of the Entra ID group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
18
18
|
|
|
19
19
|
`-n, --groupDisplayName [groupDisplayName]`
|
|
20
|
-
: The display name of the Entra ID group. Specify `groupId` or `
|
|
20
|
+
: (deprecated. Use option `groupName` instead) The display name of the Entra ID group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
21
|
+
|
|
22
|
+
`--groupName [groupName]`
|
|
23
|
+
: The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
|
|
21
24
|
|
|
22
25
|
`--ids [ids]`
|
|
23
26
|
: Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.
|
|
@@ -39,6 +42,12 @@ Update a single member specified by ID to a member of a group specified by displ
|
|
|
39
42
|
m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
|
|
40
43
|
```
|
|
41
44
|
|
|
45
|
+
Update a single member specified by ID to a member of a group specified by group name
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 entra group member set --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
|
|
49
|
+
```
|
|
50
|
+
|
|
42
51
|
Update multiple members specified by ID to members of a group specified by ID
|
|
43
52
|
|
|
44
53
|
```sh
|
|
@@ -51,6 +60,12 @@ Update a single member specified by UPN to an owner of a group specified by disp
|
|
|
51
60
|
m365 entra group member set --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
|
|
52
61
|
```
|
|
53
62
|
|
|
63
|
+
Update a single member specified by UPN to an owner of a group specified by group name
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 entra group member set --groupName Developers --userNames john.doe@contoso.com --role Owner
|
|
67
|
+
```
|
|
68
|
+
|
|
54
69
|
Update multiple members specified by UPN to owners of a group specified by ID
|
|
55
70
|
|
|
56
71
|
```sh
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# entra user session revoke
|
|
4
|
+
|
|
5
|
+
Revokes all sign-in sessions for a given user
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 entra user session revoke [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
```md definition-list
|
|
15
|
+
`-i, --userId [userId]`
|
|
16
|
+
: The id of the user. Specify either `userId` or `userName`, but not both.
|
|
17
|
+
|
|
18
|
+
`-n, --userName [userName]`
|
|
19
|
+
: The user principal name of the user. Specify either `userId` or `userName`, but not both.
|
|
20
|
+
|
|
21
|
+
`-f, --force`
|
|
22
|
+
: Don't prompt for confirmation.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Global />
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
:::info
|
|
30
|
+
|
|
31
|
+
To use this command you must be either **User Administrator** or **Global Administrator**.
|
|
32
|
+
|
|
33
|
+
:::
|
|
34
|
+
|
|
35
|
+
:::note
|
|
36
|
+
|
|
37
|
+
There might be a small delay of a few minutes before tokens are revoked.
|
|
38
|
+
|
|
39
|
+
This API doesn't revoke sign-in sessions for external users, because external users sign in through their home tenant.
|
|
40
|
+
|
|
41
|
+
:::
|
|
42
|
+
|
|
43
|
+
## Examples
|
|
44
|
+
|
|
45
|
+
Revoke sign-in sessions of a user specified by id
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 entra user session revoke --userId 4fb72b9b-d0b0-4a35-8bc1-83f9a6488c48
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Revoke sign-in sessions of a user specified by its UPN
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
m365 entra user session revoke --userName john.doe@contoso.onmicrosoft.com
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Revoke sign-in sessions of a user specified by its UPN without prompting for confirmation
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 entra user session revoke --userName john.doe@contoso.onmicrosoft.com --force
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Response
|
|
64
|
+
|
|
65
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# outlook mailbox settings get
|
|
6
|
+
|
|
7
|
+
Get the user's mailbox settings
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 outlook mailbox settings get [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-i, --userId [userId]`
|
|
19
|
+
: The ID of the Microsoft Entra user for which you want to get mailbox settings. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
|
|
20
|
+
|
|
21
|
+
`-n, --userName [userName]`
|
|
22
|
+
: The UPN of the Microsoft Entra user for which you want to get mailbox settings. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Global />
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Get mailbox settings of the signed-in user
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 outlook mailbox settings get
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Get mailbox settings of a user specified by id
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 outlook mailbox settings get --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Response
|
|
42
|
+
|
|
43
|
+
<Tabs>
|
|
44
|
+
<TabItem value="JSON">
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"archiveFolder": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA",
|
|
49
|
+
"timeZone": "Central Europe Standard Time",
|
|
50
|
+
"delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly",
|
|
51
|
+
"dateFormat": "dd.MM.yyyy",
|
|
52
|
+
"timeFormat": "H:mm",
|
|
53
|
+
"userPurpose": "user",
|
|
54
|
+
"automaticRepliesSetting": {
|
|
55
|
+
"status": "disabled",
|
|
56
|
+
"externalAudience": "all",
|
|
57
|
+
"internalReplyMessage": "On vacation. Will be back.",
|
|
58
|
+
"externalReplyMessage": "Vacation",
|
|
59
|
+
"scheduledStartDateTime": {
|
|
60
|
+
"dateTime": "2025-01-20T08:00:00.0000000",
|
|
61
|
+
"timeZone": "UTC"
|
|
62
|
+
},
|
|
63
|
+
"scheduledEndDateTime": {
|
|
64
|
+
"dateTime": "2025-01-25T18:00:00.0000000",
|
|
65
|
+
"timeZone": "UTC"
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"language": {
|
|
69
|
+
"locale": "en-US",
|
|
70
|
+
"displayName": "English (United States)"
|
|
71
|
+
},
|
|
72
|
+
"workingHours": {
|
|
73
|
+
"daysOfWeek": [
|
|
74
|
+
"monday",
|
|
75
|
+
"tuesday",
|
|
76
|
+
"wednesday",
|
|
77
|
+
"thursday",
|
|
78
|
+
"friday"
|
|
79
|
+
],
|
|
80
|
+
"startTime": "08:00:00.0000000",
|
|
81
|
+
"endTime": "16:30:00.0000000",
|
|
82
|
+
"timeZone": {
|
|
83
|
+
"name": "Central Europe Standard Time"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
</TabItem>
|
|
90
|
+
<TabItem value="Text">
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
archiveFolder : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
|
|
94
|
+
automaticRepliesSetting : {"status":"disabled","externalAudience":"all","internalReplyMessage":"","externalReplyMessage":"","scheduledStartDateTime":{"dateTime":"2025-01-20T08:00:00.0000000","timeZone":"UTC"},"scheduledEndDateTime":{"dateTime":"2025-01-25T18:00:00.0000000","timeZone":"UTC"}}
|
|
95
|
+
dateFormat : dd.MM.yyyy
|
|
96
|
+
delegateMeetingMessageDeliveryOptions: sendToDelegateOnly
|
|
97
|
+
language : {"locale":"en-US","displayName":"English (United States)"}
|
|
98
|
+
timeFormat : H:mm
|
|
99
|
+
timeZone : Central Europe Standard Time
|
|
100
|
+
userPurpose : user
|
|
101
|
+
workingHours : {"daysOfWeek":["monday","tuesday","wednesday","thursday","friday"],"startTime":"08:00:00.0000000","endTime":"16:30:00.0000000","timeZone":{"name":"Central Europe Standard Time"}}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
</TabItem>
|
|
105
|
+
<TabItem value="CSV">
|
|
106
|
+
|
|
107
|
+
```csv
|
|
108
|
+
archiveFolder,timeZone,delegateMeetingMessageDeliveryOptions,dateFormat,timeFormat,userPurpose
|
|
109
|
+
AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA,Central Europe Standard Time,sendToDelegateOnly,dd.MM.yyyy,H:mm,user
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
</TabItem>
|
|
113
|
+
<TabItem value="Markdown">
|
|
114
|
+
|
|
115
|
+
```md
|
|
116
|
+
# outlook mailbox settings get
|
|
117
|
+
|
|
118
|
+
Date: 1/17/2025
|
|
119
|
+
|
|
120
|
+
Property | Value
|
|
121
|
+
---------|-------
|
|
122
|
+
archiveFolder | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YWMyLTJhZGY2MGExMGU0MgAuAAADSG3wPE27kUeySjmT5eRT8QEAfJKVL07sbkmIfHqjbDnRgQAAAgEMAAAA
|
|
123
|
+
timeZone | Central Europe Standard Time
|
|
124
|
+
delegateMeetingMessageDeliveryOptions | sendToDelegateOnly
|
|
125
|
+
dateFormat | dd.MM.yyyy
|
|
126
|
+
timeFormat | H:mm
|
|
127
|
+
userPurpose | user
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
</TabItem>
|
|
131
|
+
</Tabs>
|
|
@@ -28,10 +28,14 @@ m365 spo field get [options]
|
|
|
28
28
|
: Server- or web-relative URL of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
29
29
|
|
|
30
30
|
`-i, --id [id]`
|
|
31
|
-
: The ID of the field to retrieve. Specify `id
|
|
31
|
+
: The ID of the field to retrieve. Specify either `id`, `title` or `internalName`.
|
|
32
32
|
|
|
33
33
|
`-t, --title [title]`
|
|
34
|
-
: The display name (case-sensitive) of the field to retrieve. Specify `id
|
|
34
|
+
: The display name (case-sensitive) of the field to retrieve. Specify either `id`, `title` or `internalName`.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
`--internalName [internalName]`
|
|
38
|
+
: The internal name (case-sensitive) of the field to retrieve. Specify either `id`, `title` or `internalName`.
|
|
35
39
|
```
|
|
36
40
|
|
|
37
41
|
<Global />
|
|
@@ -56,6 +60,12 @@ Retrieves list column by display name located in the specified site. Retrieves t
|
|
|
56
60
|
m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
|
|
57
61
|
```
|
|
58
62
|
|
|
63
|
+
Retrieves list column by internal name located in the specified site. Retrieves the list by its url.
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --internalName "Title"
|
|
67
|
+
```
|
|
68
|
+
|
|
59
69
|
## Response
|
|
60
70
|
|
|
61
71
|
<Tabs>
|
|
@@ -26,13 +26,16 @@ m365 spo field remove [options]
|
|
|
26
26
|
: Server- or web-relative URL of the list where the field is located. Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
27
|
|
|
28
28
|
`-i, --id [id]`
|
|
29
|
-
: The ID of the field to remove. Specify either `id`, `title`, or `group`.
|
|
29
|
+
: The ID of the field to remove. Specify either `id`, `title`, `internalName`, or `group`.
|
|
30
30
|
|
|
31
31
|
`-t, --title [title]`
|
|
32
|
-
: The display name (case-sensitive) of the field to remove. Specify either `id`, `title`, or `group`.
|
|
32
|
+
: The display name (case-sensitive) of the field to remove. Specify either `id`, `title`, `internalName`, or `group`.
|
|
33
|
+
|
|
34
|
+
`--internalName [internalName]`
|
|
35
|
+
: The internal name (case-sensitive) of the field to remove. Specify either `id`, `title`, `internalName`, or `group`.
|
|
33
36
|
|
|
34
37
|
`-g, --group [group]`
|
|
35
|
-
: Delete all fields from this group (case-sensitive). Specify either `id`, `title`, or `group`.
|
|
38
|
+
: Delete all fields from this group (case-sensitive). Specify either `id`, `title`, `internalName`, or `group`.
|
|
36
39
|
|
|
37
40
|
`-f, --force`
|
|
38
41
|
: Don't prompt for confirming removing the field.
|
|
@@ -60,6 +63,12 @@ Remove the list column with the specified display name, located in the specified
|
|
|
60
63
|
m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
|
|
61
64
|
```
|
|
62
65
|
|
|
66
|
+
Remove the list column with the specified display name, located in the specified site. Retrieves the list by its url.
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --internalName "Title"
|
|
70
|
+
```
|
|
71
|
+
|
|
63
72
|
Remove all site columns from the specified group.
|
|
64
73
|
|
|
65
74
|
```sh
|
|
@@ -26,10 +26,13 @@ m365 spo field set [options]
|
|
|
26
26
|
: Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
27
|
|
|
28
28
|
`-i, --id [id]`
|
|
29
|
-
: ID of the field to update. Specify either `id` or
|
|
29
|
+
: ID of the field to update. Specify either `id`, `title`, or 'internalName' but not all.
|
|
30
30
|
|
|
31
31
|
`-t, --title [title]`
|
|
32
|
-
: Title
|
|
32
|
+
: Title of the field to update. Specify either `id`, `title`, or 'internalName' but not all.
|
|
33
|
+
|
|
34
|
+
`--internalName [internalName]`
|
|
35
|
+
: Internal name of the field to update. Specify either `id`, `title`, or 'internalName' but not all.
|
|
33
36
|
|
|
34
37
|
`--updateExistingLists`
|
|
35
38
|
: Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only.
|
|
@@ -51,6 +54,12 @@ When updating column formatting for a field with the `--CustomFormatter` option,
|
|
|
51
54
|
|
|
52
55
|
Update the title of the site column specified by its internal name and push changes to existing lists.
|
|
53
56
|
|
|
57
|
+
```sh
|
|
58
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --internalName 'MyColumn' --updateExistingLists --Title 'My column'
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Update the title of the site column specified by its title and push changes to existing lists.
|
|
62
|
+
|
|
54
63
|
```sh
|
|
55
64
|
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --title 'MyColumn' --updateExistingLists --Title 'My column'
|
|
56
65
|
```
|
|
@@ -67,11 +76,16 @@ Update the description of a column specified by the ID on a list retrieved by th
|
|
|
67
76
|
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
|
|
68
77
|
```
|
|
69
78
|
|
|
70
|
-
Update column formatting of the specified list column.
|
|
79
|
+
Update column formatting of the specified list column based on title.
|
|
71
80
|
|
|
72
81
|
```sh
|
|
73
82
|
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
|
|
74
83
|
```
|
|
84
|
+
Update column formatting of the specified list column based on internalName.
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --internalName 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
|
|
88
|
+
```
|
|
75
89
|
|
|
76
90
|
## Response
|
|
77
91
|
|