From 0332846d4fc6e4800eb2246ac1c9fb8c5b715283 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 30 Mar 2018 17:57:31 -0700 Subject: [PATCH] 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. --- .../exchange/mailboxes/Get-Mailbox.md | 34 ++- .../mailboxes/Get-RecoverableItems.md | 242 +++++++++++++++ .../exchange/mailboxes/New-Mailbox.md | 23 +- .../exchange/mailboxes/Remove-Mailbox.md | 30 +- .../mailboxes/Restore-RecoverableItems.md | 275 ++++++++++++++++++ .../exchange/mailboxes/Set-Mailbox.md | 30 +- .../exchange/users-and-groups/Get-User.md | 34 ++- 7 files changed, 649 insertions(+), 19 deletions(-) create mode 100644 exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md create mode 100644 exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md index 820930cacd..9b6f267da2 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/mailboxes/Get-Mailbox.md @@ -137,7 +137,15 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -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. +The Arbitration switch filters the results by arbitration mailboxes. You don't need to specify a value with this switch. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +Notes: + +- If you don't use this switch, the command can't find arbitration mailboxes. + +- 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. ```yaml Type: SwitchParameter @@ -641,13 +649,21 @@ Accept wildcard characters: False ``` ### -AuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +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. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't return this type of arbitration mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2016 Required: False Position: Named @@ -657,13 +673,21 @@ Accept wildcard characters: False ``` ### -AuxAuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +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. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't return this type of arbitration mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md new file mode 100644 index 0000000000..99233f7d46 --- /dev/null +++ b/exchange/exchange-ps/exchange/mailboxes/Get-RecoverableItems.md @@ -0,0 +1,242 @@ +--- +applicable: Exchange Online +schema: 2.0.0 +--- +# Get-RecoverableItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +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. + +For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). + +## SYNTAX + +``` +Get-RecoverableItems -Identity [-EntryID ] [-FilterEndTime ] [-FilterItemType ] [-FilterStartTime ] [-LastParentFolderID ] [-ResultSize ] [-SourceFolder ] [-SubjectContains ] [] +``` + +## DESCRIPTION +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). + +## EXAMPLES + +### Example 1 +``` +Get-RecoverableItems -Identity laura@contoso.com -Subject -SubjectContains "FY17 Accounting" -FilterItemType IPM.Note -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" +``` + +This example returns all of the available recoverable deleted messages with the specified subject in the mailbox laura@contoso.com for the specified date/time range. + +## PARAMETERS + +### -Identity +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. + +For example: + +- Name + +- Display name + +- Alias + +- Distinguished name (DN) + +- Canonical DN + +- \\ + +- Email address + +- GUID + +- LegacyExchangeDN + +- SamAccountName + +- User ID or user principal name (UPN) + +```yaml +Type: GeneralMailboxOrMailUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryID +The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. + +You can find the EntryID for specific items by using other search filters on the Get-ReoverableItems cmdlet (subject, date range, etc.). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterEndTime +The FilterEndTime specifies the end date/time of the date range. + +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". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterItemType +The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: + +- IPM.Appointment (Meetings and appointments) + +- IPM.Contact + +- IPM.File + +- IPM.Note + +- IPM.Task + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterStartTime +The FilterStartTime specifies the start date/time of the date range. + +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". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastParentFolderID +The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceFolder +The SourceFolder parameter specifies the folder in the mailbox to search for deleted items. Valid values are: + +- DeletedItems: The Deleted Items folder. + +- RecoverableItems: Recoverable items that have been deleted from the Deleted Items folder. + +If you don't use this parameter, the command will search both locations. + +```yaml +Type: DeletedItems | RecoverableItems +Parameter Sets: (All) +Aliases: +Accepted values: DeletedItems, RecoverableItems +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContains +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 ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### +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. + +## OUTPUTS + +### +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. + +## NOTES + +## RELATED LINKS + +[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/Get-RecoverableItems) \ No newline at end of file diff --git a/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md index 8abdac2490..30a33877e3 100644 --- a/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md +++ b/exchange/exchange-ps/exchange/mailboxes/New-Mailbox.md @@ -704,7 +704,11 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -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. +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. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +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. ```yaml Type: SwitchParameter @@ -2065,7 +2069,13 @@ Accept wildcard characters: False ``` ### -AuditLog -This parameter is reserved for internal Microsoft use. +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. + +Notes: + +- This switch is required only if you're creating this type of arbitration mailbox. + +- The Arbitration switch doesn't work for creating this type of arbitration mailbox. ```yaml Type: SwitchParameter @@ -2081,7 +2091,14 @@ Accept wildcard characters: False ``` ### -AuxAuditLog -This parameter is reserved for internal Microsoft use. +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. + +Notes: + +- This switch is required only if you're creating this type of arbitration mailbox. + +- The Arbitration switch doesn't work for creating this type of arbitration mailbox. + ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md index 7a415ac6cf..cd8aeffa8a 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/mailboxes/Remove-Mailbox.md @@ -161,7 +161,15 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -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. +The Arbitration switch specifies that the mailbox you're removing is an arbitration mailbox. You don't need to specify a value with this switch. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +Notes: + +- If you don't use this switch, the command can't find the arbitration mailbox to remove. + +- To remove 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. ```yaml Type: SwitchParameter @@ -379,7 +387,15 @@ Accept wildcard characters: False ``` ### -AuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +The AuditLog switch specifies the mailbox you're removing is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't work for removing this type of arbitration mailbox. ```yaml Type: SwitchParameter @@ -395,7 +411,15 @@ Accept wildcard characters: False ``` ### -AuxAuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +The AuxAuditLog switch specifies the mailbox you're removing is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't work for removing this type of arbitration mailbox. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md new file mode 100644 index 0000000000..3be6d13f06 --- /dev/null +++ b/exchange/exchange-ps/exchange/mailboxes/Restore-RecoverableItems.md @@ -0,0 +1,275 @@ +--- +applicable: Exchange Online +schema: 2.0.0 +--- + +# Restore-RecoverableItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Restore-RecoverableItems items cmdlet to restore deleted items in the Recoverable Items folder in mailboxes. You use the Get-RecoverableItems cmdlet to find the deleted items to recover. + +For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx). + +## SYNTAX + +``` +Restore-RecoverableItems -Identity [-EntryID ] [-FilterEndTime ] [-FilterItemType ] [-FilterStartTime ] [-LastParentFolderID ] [-ResultSize ] [-SourceFolder ] [-SubjectContains ] [] +``` + +## DESCRIPTION +Items are restored to the original folder location if the information is available for the item. If the information can't be found, the item is restored to the default folder for the item type (Inbox for messages, Calendar for meetings and appointments, etc.). + +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). + +## EXAMPLES + +### Example 1 +``` +Restore-RecoverableItems -Identity laura@contoso.com -FilterItemType IPM.Note -SubjectContains "FY17 Accounting" -FilterStartTime "2/1/2018 12:00:00 AM" -FilterEndTime "2/5/2018 11:59:59 PM" +``` + +After using the Get-RecoverableItems cmdlet to verify the existence of the item, this example restores the specified deleted item from the specified mailbox: + +- Mailbox: laura@contoso.com + +- Item type: Email message + +- Message subject: FY17 Accounting + +- Location: Recoverable Items\Deletions + +- Date range: 2/1/2018 to 2/5/2018 + +### Example 2 +``` +$mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv"; $mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} +``` + +This example restores the deleted email message "Project X" for the mailboxes that are specified in the comma-separated value (CSV) file C:\My Documents\RestoreMessage.csv. The CSV file uses the header value SMTPAddress, and contains the email address of each mailbox on a separate line like this: + +SMTPAddress + +chris@contoso.com + +michelle@contoso.com + +laura@contoso.com + +julia@contoso.com + +The first command reads the CSV file and writes the information to the variable $mailboxes. The second command restores the specified message from the Deleted Items folder in those mailboxes. + + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that contains the Recoverable Items folder where you want to restore items from. You can use any value that uniquely identifies the mailbox. + +For example: + +- Name + +- Display name + +- Alias + +- Distinguished name (DN) + +- Canonical DN + +- \\ + +- Email address + +- GUID + +- LegacyExchangeDN + +- SamAccountName + +- User ID or user principal name (UPN) + +```yaml +Type: GeneralMailboxOrMailUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntryID +The EntryID parameter specifies the deleted item that you want to restore. The EntryID value for the deleted item is unique in the mailbox. + +You can find the EntryID for specific items by using other search filters on the Get-ReoverableItems cmdlet (subject, date range, etc.). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterEndTime +The FilterEndTime specifies the end date/time of the date range. + +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". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterItemType +The FilterItemType parameter filters the results by the specified MessageClass (ItemClass) property value of the deleted item. For example: + +- IPM.Appointment (Meetings and appointments) + +- IPM.Contact + +- IPM.File + +- IPM.Note + +- IPM.Task + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterStartTime +The FilterStartTime specifies the start date/time of the date range. + +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". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastParentFolderID +The LastParentFolderID parameter specifies the FolderID value of the item before it was deleted. For example, 53B93149989CA54DBC9702AE619B9CCA000062CE9397. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +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. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceFolder +The SourceFolder parameter specifies the folder in the mailbox to search for deleted items. Valid values are: + +- DeletedItems: The Deleted Items folder. + +- RecoverableItems: Recoverable items that have been deleted from the Deleted Items folder. + +If you don't use this parameter, the command will search both locations. + +```yaml +Type: DeletedItems | RecoverableItems +Parameter Sets: (All) +Aliases: +Accepted values: DeletedItems, RecoverableItems +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectContains +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 ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### +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. + +## OUTPUTS + +### +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. + +## NOTES + +## RELATED LINKS + +[Online Version](https://docs.microsoft.com/powershell/module/exchange/mailboxes/Restore-RecoverableItems) \ No newline at end of file diff --git a/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md b/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md index da1582c0b2..c68f654530 100644 --- a/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md @@ -580,7 +580,15 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -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. +The Arbitration switch specifies that the mailbox you're modifying is an arbitration mailbox. You don't need to specify a value with this switch. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +Notes: + +- If you don't use this switch, the command can't find the arbitration mailbox to modify. + +- To modify 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. ```yaml Type: SwitchParameter @@ -3648,7 +3656,15 @@ Accept wildcard characters: False ``` ### -AuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +The AuditLog switch specifies the mailbox you're modifying is an arbitration mailbox that's used to store audit log settings. You don't need to specify a value with this switch. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't work for modifying this type of arbitration mailbox. ```yaml Type: SwitchParameter @@ -4575,7 +4591,15 @@ Accept wildcard characters: False ``` ### -AuxAuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +The AuxAuditLog switch specifies the mailbox you're modifying is an arbitration mailbox that's used to store audit log data. You don't need to specify a value with this switch. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't work for modifying this type of arbitration mailbox. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/users-and-groups/Get-User.md b/exchange/exchange-ps/exchange/users-and-groups/Get-User.md index a6a133f7d6..419b9d33c8 100644 --- a/exchange/exchange-ps/exchange/users-and-groups/Get-User.md +++ b/exchange/exchange-ps/exchange/users-and-groups/Get-User.md @@ -96,7 +96,15 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -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. +The Arbitration switch filters the results by arbitration mailboxes. You don't need to specify a value with this switch. + +Arbitration mailboxes are system mailbox that are used for storing different types of system data and for managing messaging approval workflow. + +Notes: + +- If you don't use this switch, the command can't find arbitration mailboxes. + +- 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. ```yaml Type: SwitchParameter @@ -370,13 +378,21 @@ Accept wildcard characters: False ``` ### -AuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +The AuditLog 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. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't return this type of arbitration mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2016 Required: False Position: Named @@ -434,13 +450,21 @@ Accept wildcard characters: False ``` ### -AuxAuditLog -This parameter is reserved for internal Microsoft use. +This parameter is available only in on-premises Exchange. + +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. + +Notes: + +- If you don't use this switch, the command can't find this type of arbitration mailbox. + +- The Arbitration switch doesn't return this type of arbitration mailbox. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2016 Required: False Position: Named