Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 2.71 KB

File metadata and controls

46 lines (36 loc) · 2.71 KB

Set-CIPPLitigationHold

SYNOPSIS

Sets the litigation hold status for a mailbox.

DESCRIPTION

The Set-CIPPLitigationHold function enables or disables litigation hold for a specified mailbox in the customer's tenant. Litigation hold preserves all mailbox content, including deleted items and original versions of modified items. Optionally, you can specify a duration for the hold in days.

PARAMETERS

-CustomerTenantID

Foo Foo
Specifies the customer tenant ID. This parameter is mandatory.

-Identity

Foo Foo
Specifies the identity of the mailbox (typically the GUID or primary SMTP address). This parameter is mandatory.

-UserPrincipalName

Foo Foo
Specifies the User Principal Name of the mailbox owner. This parameter is used for logging and display purposes. This parameter is mandatory.

-Disable

Foo Foo Foo
Specifies whether to disable litigation hold. If this switch is present, litigation hold will be disabled. If not present, litigation hold will be enabled. This parameter is optional.

-Days

Foo Foo Foo
Specifies the duration of the litigation hold in days. This parameter is only applicable when enabling litigation hold (Disable switch not present). If set to 0 or not specified, the hold will be indefinite. This parameter is optional.

EXAMPLE 1

PS > Set-CIPPLitigationHold -CustomerTenantID "contoso.onmicrosoft.com" -Identity "john.doe@contoso.com" -UserPrincipalName "john.doe@contoso.com"

Enables indefinite litigation hold for john.doe@contoso.com's mailbox.

EXAMPLE 2

PS > Set-CIPPLitigationHold -CustomerTenantID "contoso.onmicrosoft.com" -Identity "jane.smith@contoso.com" -UserPrincipalName "jane.smith@contoso.com" -Days 365

Enables litigation hold for jane.smith@contoso.com's mailbox for 365 days.

EXAMPLE 3

PS > Set-CIPPLitigationHold -CustomerTenantID "contoso.onmicrosoft.com" -Identity "bob.jones@contoso.com" -UserPrincipalName "bob.jones@contoso.com" -Disable

Disables litigation hold for bob.jones@contoso.com's mailbox.