Skip to content

Commit 0332846

Browse files
chrisdachrisda
committed
Updates per VSO:2215602 and VSO:2215602
New Get/Restore-RecoverableItems cmdlets, and write descriptions for the AuditLog and AuxAuditLog parameters (and related updates to the Arbitration parameter) in Get/New/Remove/Set-Mailbox and Get-User cmdlets.
1 parent 4e08dcb commit 0332846

File tree

7 files changed

+649
-19
lines changed

7 files changed

+649
-19
lines changed

‎exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,15 @@ Accept wildcard characters: False
137137
### -Arbitration
138138
This parameter is available only in on-premises Exchange.
139139
140-
The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.
140+
The Arbitration switch filters the results by arbitration mailboxes. You don't need to specify a value with this switch.
141+
142+
Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow.
143+
144+
Notes:
145+
146+
- If you don't use this switch, the command can't find arbitration mailboxes.
147+
148+
- To return arbitration mailboxes that are used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration switch.
141149
142150
```yaml
143151
Type: SwitchParameter
@@ -641,13 +649,21 @@ Accept wildcard characters: False
641649
```
642650
643651
### -AuditLog
644-
This parameter is reserved for internal Microsoft use.
652+
This parameter is available only in on-premises Exchange.
653+
654+
The AuxAuditLog switch filters the results by arbitration mailboxes that are used to store audit log settings. You don't need to specify a value with this switch.
655+
656+
Notes:
657+
658+
- If you don't use this switch, the command can't find this type of arbitration mailbox.
659+
660+
- The Arbitration switch doesn't return this type of arbitration mailbox.
645661
646662
```yaml
647663
Type: SwitchParameter
648664
Parameter Sets: (All)
649665
Aliases:
650-
Applicable: Exchange Server 2016, Exchange Online
666+
Applicable: Exchange Server 2016
651667

652668
Required: False
653669
Position: Named
@@ -657,13 +673,21 @@ Accept wildcard characters: False
657673
```
658674
659675
### -AuxAuditLog
660-
This parameter is reserved for internal Microsoft use.
676+
This parameter is available only in on-premises Exchange.
677+
678+
The AuxAuditLog switch filters the results by arbitration mailboxes that are used to store audit log data. You don't need to specify a value with this switch.
679+
680+
Notes:
681+
682+
- If you don't use this switch, the command can't find this type of arbitration mailbox.
683+
684+
- The Arbitration switch doesn't return this type of arbitration mailbox.
661685
662686
```yaml
663687
Type: SwitchParameter
664688
Parameter Sets: (All)
665689
Aliases:
666-
Applicable: Exchange Server 2016, Exchange Online
690+
Applicable: Exchange Server 2016
667691

668692
Required: False
669693
Position: Named

‎exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md

Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
---
2+
applicable: Exchange Online
3+
schema: 2.0.0
4+
---
5+
# Get-RecoverableItems
6+
7+
## SYNOPSIS
8+
This cmdlet is available only in the cloud-based service.
9+
10+
Use the Get-RecoverableItems items cmdlet to view deleted items in the Recoverable Items folder in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them.
11+
12+
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
13+
14+
## SYNTAX
15+
16+
```
17+
Get-RecoverableItems -Identity <GeneralMailboxOrMailUserIdParameter> [-EntryID <String>] [-FilterEndTime <DateTime>] [-FilterItemType <String>] [-FilterStartTime <DateTime>] [-LastParentFolderID <String>] [-ResultSize <Unlimited>] [-SourceFolder <DeletedItems | RecoverableItems>] [-SubjectContains <String>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```
27+
Get-RecoverableItems -Identity [email protected] -Subject -SubjectContains "FY17 Accounting" -FilterItemType IPM.Note -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM"
28+
```
29+
30+
This example returns all of the available recoverable deleted messages with the specified subject in the mailbox [email protected] for the specified date/time range.
31+
32+
## PARAMETERS
33+
34+
### -Identity
35+
The Identity parameter specifies the mailbox that contains the Recoverable Items folder that you want to view. You can use any value that uniquely identifies the mailbox.
36+
37+
For example:
38+
39+
- Name
40+
41+
- Display name
42+
43+
- Alias
44+
45+
- Distinguished name (DN)
46+
47+
- Canonical DN
48+
49+
- \<domain name>\<account name>
50+
51+
- Email address
52+
53+
- GUID
54+
55+
- LegacyExchangeDN
56+
57+
- SamAccountName
58+
59+
- User ID or user principal name (UPN)
60+
61+
```yaml
62+
Type: GeneralMailboxOrMailUserIdParameter
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: Exchange Online
66+
67+
Required: False
68+
Position: 1
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -EntryID
75+
The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox.
76+
77+
You can find the EntryID for specific items by using other search filters on the Get-ReoverableItems cmdlet (subject, date range, etc.).
78+
79+
```yaml
80+
Type: String
81+
Parameter Sets: (All)
82+
Aliases:
83+
Applicable: Exchange Online
84+
85+
Required: False
86+
Position: Named
87+
Default value: None
88+
Accept pipeline input: False
89+
Accept wildcard characters: False
90+
```
91+
92+
### -FilterEndTime
93+
The FilterEndTime specifies the end date/time of the date range.
94+
95+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
96+
97+
```yaml
98+
Type: DateTime
99+
Parameter Sets: (All)
100+
Aliases:
101+
Applicable: Exchange Online
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -FilterItemType
111+
The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example:
112+
113+
- IPM.Appointment (Meetings and appointments)
114+
115+
- IPM.Contact
116+
117+
- IPM.File
118+
119+
- IPM.Note
120+
121+
- IPM.Task
122+
123+
```yaml
124+
Type: String
125+
Parameter Sets: (All)
126+
Aliases:
127+
Applicable: Exchange Online
128+
129+
Required: False
130+
Position: Named
131+
Default value: None
132+
Accept pipeline input: False
133+
Accept wildcard characters: False
134+
```
135+
136+
### -FilterStartTime
137+
The FilterStartTime specifies the start date/time of the date range.
138+
139+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
140+
141+
```yaml
142+
Type: DateTime
143+
Parameter Sets: (All)
144+
Aliases:
145+
Applicable: Exchange Online
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### -LastParentFolderID
155+
The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397.
156+
157+
```yaml
158+
Type: String
159+
Parameter Sets: (All)
160+
Aliases:
161+
Applicable: Exchange Online
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### -ResultSize
171+
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
172+
173+
```yaml
174+
Type: Unlimited
175+
Parameter Sets: (All)
176+
Aliases:
177+
Applicable: Exchange Online
178+
179+
Required: False
180+
Position: Named
181+
Default value: None
182+
Accept pipeline input: False
183+
Accept wildcard characters: False
184+
```
185+
186+
### -SourceFolder
187+
The SourceFolder parameter specifies the folder in the mailbox to search for deleted items. Valid values are:
188+
189+
- DeletedItems: The Deleted Items folder.
190+
191+
- RecoverableItems: Recoverable items that have been deleted from the Deleted Items folder.
192+
193+
If you don't use this parameter, the command will search both locations.
194+
195+
```yaml
196+
Type: DeletedItems | RecoverableItems
197+
Parameter Sets: (All)
198+
Aliases:
199+
Accepted values: DeletedItems, RecoverableItems
200+
Applicable: Exchange Online
201+
202+
Required: False
203+
Position: Named
204+
Default value: None
205+
Accept pipeline input: False
206+
Accept wildcard characters: False
207+
```
208+
209+
### -SubjectContains
210+
The SubjectContains parameter filters the items by the specified text value in the Subject field. If the value contains spaces, enclose the value in quotation marks (").
211+
212+
```yaml
213+
Type: String
214+
Parameter Sets: (All)
215+
Aliases:
216+
Applicable: Exchange Online
217+
218+
Required: False
219+
Position: Named
220+
Default value: None
221+
Accept pipeline input: False
222+
Accept wildcard characters: False
223+
```
224+
225+
### CommonParameters
226+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
227+
228+
## INPUTS
229+
230+
###
231+
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
232+
233+
## OUTPUTS
234+
235+
###
236+
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
237+
238+
## NOTES
239+
240+
## RELATED LINKS
241+
242+
[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/Get-RecoverableItems)

‎exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -704,7 +704,11 @@ Accept wildcard characters: False
704704
### -Arbitration
705705
This parameter is available only in on-premises Exchange.
706706
707-
The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.
707+
The Arbitration switch specifies that the mailbox you're creating is an arbitration mailbox. You don't need to specify a value with this switch.
708+
709+
Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow.
710+
711+
Note: To create an arbitration mailbox that's used to store audit log settings or data, you need to use the AuditLog or AuxAuditLog switches instead of the Arbitration switch.
708712
709713
```yaml
710714
Type: SwitchParameter
@@ -2065,7 +2069,13 @@ Accept wildcard characters: False
20652069
```
20662070

20672071
### -AuditLog
2068-
This parameter is reserved for internal Microsoft use.
2072+
The AuditLog switch specifies the mailbox is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch.
2073+
2074+
Notes:
2075+
2076+
- This switch is required only if you're creating this type of arbitration mailbox.
2077+
2078+
- The Arbitration switch doesn't work for creating this type of arbitration mailbox.
20692079

20702080
```yaml
20712081
Type: SwitchParameter
@@ -2081,7 +2091,14 @@ Accept wildcard characters: False
20812091
```
20822092

20832093
### -AuxAuditLog
2084-
This parameter is reserved for internal Microsoft use.
2094+
The AuxAuditLog switch specifies the mailbox is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch.
2095+
2096+
Notes:
2097+
2098+
- This switch is required only if you're creating this type of arbitration mailbox.
2099+
2100+
- The Arbitration switch doesn't work for creating this type of arbitration mailbox.
2101+
20852102

20862103
```yaml
20872104
Type: SwitchParameter

0 commit comments

Comments
 (0)