Skip to content

Commit 33df96c

Browse files
committed
Update Set-Mailbox.md
Added RemoveOrphandedHolds per email request.
1 parent 8fe0d06 commit 33df96c

File tree

1 file changed

+143
-14
lines changed

1 file changed

+143
-14
lines changed

exchange/exchange-ps/exchange/mailboxes/Set-Mailbox.md

Lines changed: 143 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -790,6 +790,122 @@ Set-Mailbox [-Identity] <MailboxIdParameter> [-ExcludeFromOrgHolds <String>]
790790
[-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>]
791791
```
792792

793+
### RemoveOrphanedHolds
794+
```
795+
Set-Mailbox [-Identity] <MailboxIdParameter> [-RemoveOrphanedHolds <String[]>]
796+
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
797+
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
798+
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>]
799+
[-AccountDisabled <$true | $false>]
800+
[-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>]
801+
[-Alias <String>]
802+
[-ApplyMandatoryProperties]
803+
[-ArchiveName <MultiValuedProperty>]
804+
[-AuditAdmin <MultiValuedProperty>]
805+
[-AuditDelegate <MultiValuedProperty>]
806+
[-AuditEnabled <$true | $false>]
807+
[-AuditLogAgeLimit <EnhancedTimeSpan>]
808+
[-AuditOwner <MultiValuedProperty>]
809+
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
810+
[-CalendarRepairDisabled <$true | $false>]
811+
[-CalendarVersionStoreDisabled <$true | $false>]
812+
[-Confirm]
813+
[-CreateDTMFMap <$true | $false>]
814+
[-CustomAttribute1 <String>]
815+
[-CustomAttribute10 <String>]
816+
[-CustomAttribute11 <String>]
817+
[-CustomAttribute12 <String>]
818+
[-CustomAttribute13 <String>]
819+
[-CustomAttribute14 <String>]
820+
[-CustomAttribute15 <String>]
821+
[-CustomAttribute2 <String>]
822+
[-CustomAttribute3 <String>]
823+
[-CustomAttribute4 <String>]
824+
[-CustomAttribute5 <String>]
825+
[-CustomAttribute6 <String>]
826+
[-CustomAttribute7 <String>]
827+
[-CustomAttribute8 <String>]
828+
[-CustomAttribute9 <String>]
829+
[-DataEncryptionPolicy <DataEncryptionPolicyIdParameter>
830+
[-DefaultPublicFolderMailbox <RecipientIdParameter>]
831+
[-DeliverToMailboxAndForward <$true | $false>]
832+
[-DisplayName <String>]
833+
[-ElcProcessingDisabled <$true | $false>]
834+
[-EmailAddresses <ProxyAddressCollection>]
835+
[-EnableRoomMailboxAccount <$true | $false>]
836+
[-EndDateForRetentionHold <DateTime>]
837+
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
838+
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
839+
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
840+
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
841+
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
842+
[-ExternalOofOptions <ExternalOofOptions>]
843+
[-Force]
844+
[-ForwardingAddress <RecipientIdParameter>]
845+
[-ForwardingSmtpAddress <ProxyAddress>]
846+
[-GrantSendOnBehalfTo <MultiValuedProperty>]
847+
[-HiddenFromAddressListsEnabled <$true | $false>]
848+
[-ImListMigrationCompleted <$true | $false>]
849+
[-ImmutableId <String>]
850+
[-InactiveMailbox]
851+
[-IsExcludedFromServingHierarchy <$true | $false>]
852+
[-IssueWarningQuota <Unlimited>]
853+
[-JournalArchiveAddress <SmtpAddress>]
854+
[-Languages <MultiValuedProperty>]
855+
[-LitigationHoldDate <DateTime>]
856+
[-LitigationHoldDuration <Unlimited>]
857+
[-LitigationHoldEnabled <$true | $false>]
858+
[-LitigationHoldOwner <String>]
859+
[-MailboxRegion <String>]
860+
[-MailTip <String>]
861+
[-MailTipTranslations <MultiValuedProperty>]
862+
[-MaxReceiveSize <Unlimited>]
863+
[-MaxSendSize <Unlimited>]
864+
[-MessageCopyForSendOnBehalfEnabled <$true | $false>]
865+
[-MessageCopyForSentAsEnabled <$true | $false>]
866+
[-MessageTrackingReadStatusEnabled <$true | $false>]
867+
[-MicrosoftOnlineServicesID <SmtpAddress>]
868+
[-ModeratedBy <MultiValuedProperty>]
869+
[-ModerationEnabled <$true | $false>]
870+
[-Name <String>]
871+
[-Office <String>]
872+
[-Password <SecureString>]
873+
[-ProhibitSendQuota <Unlimited>]
874+
[-ProhibitSendReceiveQuota <Unlimited>]
875+
[-ProvisionedForOfficeGraph]
876+
[-PublicFolder]
877+
[-RejectMessagesFrom <MultiValuedProperty>]
878+
[-RejectMessagesFromDLMembers <MultiValuedProperty>]
879+
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>]
880+
[-RequireSenderAuthenticationEnabled <$true | $false>]
881+
[-ResourceCapacity <System.Int32>]
882+
[-ResourceCustom <MultiValuedProperty>]
883+
[-RetainDeletedItemsFor <EnhancedTimeSpan>]
884+
[-RetentionComment <String>]
885+
[-RetentionHoldEnabled <$true | $false>]
886+
[-RetentionPolicy <MailboxPolicyIdParameter>]
887+
[-RetentionUrl <String>]
888+
[-RoleAssignmentPolicy <MailboxPolicyIdParameter>]
889+
[-RoomMailboxPassword <SecureString>]
890+
[-RulesQuota <ByteQuantifiedSize>]
891+
[-SecondaryAddress <String>]
892+
[-SecondaryDialPlan <UMDialPlanIdParameter>]
893+
[-SendModerationNotifications <TransportModerationNotificationFlags>]
894+
[-SharingPolicy <SharingPolicyIdParameter>]
895+
[-SimpleDisplayName <String>]
896+
[-SingleItemRecoveryEnabled <$true | $false>]
897+
[-SkipDualWrite]
898+
[-StartDateForRetentionHold <DateTime>]
899+
[-StsRefreshTokensValidFrom <DateTime>]
900+
[-Type <Regular | Room | Equipment | Shared>]
901+
[-UMDtmfMap <MultiValuedProperty>]
902+
[-UseDatabaseQuotaDefaults <System.$true | $false>]
903+
[-UserCertificate <MultiValuedProperty>]
904+
[-UserSMimeCertificate <MultiValuedProperty>]
905+
[-WhatIf]
906+
[-WindowsEmailAddress <SmtpAddress>] [<CommonParameters>]
907+
```
908+
793909
## DESCRIPTION
794910
You can use this cmdlet for one mailbox at a time. To perform bulk management, you can pipeline the output of various Get- cmdlets (for example, the Get-Mailbox or Get-User cmdlets) and configure several mailboxes in a single-line command. You can also use the Set-Mailbox cmdlet in scripts.
795911

@@ -2021,7 +2137,7 @@ You can use the Get-DataEncryptionPolicy cmdlet to view the available policies.
20212137
20222138
```yaml
20232139
Type: DataEncryptionPolicyIdParameter
2024-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
2140+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
20252141
Aliases:
20262142
Applicable: Exchange Online
20272143
Required: False
@@ -2169,7 +2285,7 @@ The ElcProcessingDisabled parameter specifies whether to prevent the Managed Fol
21692285
21702286
```yaml
21712287
Type: $true | $false
2172-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
2288+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
21732289
Aliases:
21742290
Applicable: Exchange Online
21752291
Required: False
@@ -2307,7 +2423,7 @@ This parameter is available only in Exchange Online.
23072423
23082424
The ExcludeFromOrgHolds parameter excludes the mailbox from one or more organization-wide Office 365 retention policies. This parameter can only be used for inactive mailboxes. A valid value for this parameter is the GUID of the organization-wide Office 365 retention policy that the inactive mailbox is excluded from. To find the GUID values of organization-wide Office 365 retention policies, run the command Get-OrganizationConfig | Format-List InplaceHolds. Note that retention policies assigned to mailboxes are prefaced by 'mbx'.
23092425
2310-
You can specify multiple values for this parameter by using the syntax "GUID1","GUID2","GUIDX".
2426+
You can specify multiple values by using the syntax: "GUID1","GUID2",..."GUIDX".
23112427
23122428
When you use this parameter, use the DistinguishedName or ExchangeGuid property value for the identity of the inactive mailbox (those are the values that guarantee uniqueness).
23132429
@@ -2814,7 +2930,7 @@ You can't use this switch to modify other properties on inactive mailboxes.
28142930
28152931
```yaml
28162932
Type: SwitchParameter
2817-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
2933+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
28182934
Aliases:
28192935
Applicable: Exchange Online
28202936
Required: False
@@ -2917,7 +3033,7 @@ This parameter is reserved for internal Microsoft use.
29173033
29183034
```yaml
29193035
Type: SmtpAddress
2920-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
3036+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
29213037
Aliases:
29223038
Applicable: Exchange Online
29233039
Required: False
@@ -3134,7 +3250,7 @@ This parameter is reserved for internal Microsoft use.
31343250
31353251
```yaml
31363252
Type: String
3137-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
3253+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
31383254
Aliases:
31393255
Applicable: Exchange Online
31403256
Required: False
@@ -3450,7 +3566,7 @@ The MicrosoftOnlineServicesID parameter specifies the Microsoft work or school a
34503566

34513567
```yaml
34523568
Type: SmtpAddress
3453-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
3569+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
34543570
Aliases:
34553571
Applicable: Exchange Online
34563572
Required: False
@@ -3798,7 +3914,7 @@ This parameter is reserved for internal Microsoft use.
37983914

37993915
```yaml
38003916
Type: SwitchParameter
3801-
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds
3917+
Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveOrphanedHolds
38023918
Aliases:
38033919
Applicable: Exchange Online
38043920
Required: False
@@ -4166,6 +4282,21 @@ Accept pipeline input: False
41664282
Accept wildcard characters: False
41674283
```
41684284

4285+
### -RemoveOrphanedHolds
4286+
{{Fill RemoveOrphanedHolds Description}}
4287+
4288+
```yaml
4289+
Type: String[]
4290+
Parameter Sets: RemoveOrphanedHolds
4291+
Aliases:
4292+
Applicable: Exchange Online
4293+
Required: False
4294+
Position: Named
4295+
Default value: None
4296+
Accept pipeline input: False
4297+
Accept wildcard characters: False
4298+
```
4299+
41694300
### -RemovePicture
41704301
This parameter is available only in on-premises Exchange.
41714302

@@ -4448,7 +4579,7 @@ Accept wildcard characters: False
44484579
```
44494580

44504581
### -RoomMailboxPassword
4451-
Use the RoomMailboxPassword parameter to changethe password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.)
4582+
Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.)
44524583

44534584
This parameter uses the syntax (ConvertTo-SecureString -String '\<password\>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter.
44544585

@@ -4534,7 +4665,7 @@ Accept wildcard characters: False
45344665
### -SCLDeleteThreshold
45354666
This parameter is available only in on-premises Exchange.
45364667

4537-
The SCLDeleteThreshold parameter specifies the SCL delete threshold. When the SCLDeleteEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value aresilently deleted.
4668+
The SCLDeleteThreshold parameter specifies the SCL delete threshold. When the SCLDeleteEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are silently deleted.
45384669

45394670
A valid value is an integer from 0 through 9. This value should be greater than the other SCL\*Threshold values.
45404671

@@ -4662,7 +4793,7 @@ Accept wildcard characters: False
46624793
### -SCLRejectThreshold
46634794
This parameter is available only in on-premises Exchange.
46644795

4665-
The SCLRejectThreshold parameter specifies the SCL reject threshold. When the SCLRejectEnabled parameter is set to $true, messageswith an SCL greater than or equal to the specified value are rejected, and an NDR is sent to the sender.
4796+
The SCLRejectThreshold parameter specifies the SCL reject threshold. When the SCLRejectEnabled parameter is set to $true, messages with an SCL greater than or equal to the specified value are rejected, and an NDR is sent to the sender.
46664797

46674798
A valid value is an integer from 0 through 9. This value should be less than the SCLDeleteThreshold value, but greater than the SCLQuarantineThreshold value.
46684799

@@ -4994,9 +5125,7 @@ Accept wildcard characters: False
49945125
```
49955126

49965127
### -UseDatabaseQuotaDefaults
4997-
This parameter is available only in on-premises Exchange.
4998-
4999-
The UseDatabaseQuotaDefaults parameter specifies whether the mailbox uses the applicable quota values configured on the mailbox database or configured on the mailbox. Valid values are:
5128+
The UseDatabaseQuotaDefaults parameter specifies whether the mailbox uses the applicable quota values that are configured on the mailbox or on the mailbox database. Valid values are:
50005129

50015130
- $true: The mailbox uses the applicable quota values that are configured on the mailbox database. Any of those quota values configured directly on the mailbox are ignored.
50025131

0 commit comments

Comments
 (0)