@pnp/cli-microsoft365 10.4.0-beta.791a39c → 10.4.0-beta.946980f

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.
@@ -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` or `title` but not both.
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` or `title` but not both.
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 `title` but not both.
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 or internal name of the field to update. Specify either `id` or `title` but not both.
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