UpdateDeviceLegalHoldState

UpdateDeviceLegalHoldState is used to disable and re-enable the retention and erase options. When disabled, the legal hold keeps data from being deleted from the vault, and it keeps the device from being deleted. You might use this feature when you are legally required to preserve data, for example because of a lawsuit or a user investigation. The data can be made available upon request, and it prevents someone from trying to delete files or entire backups. You can re-enable the device when the legal hold is no longer needed. The equivalent options in the dashboard are the Put on legal hold and Remove from legal hold buttons on the Manage device tab for a device.

SeeUpdateDeviceLegalHoldState for an example PowerShell script.

Signature

ServiceResponse UpdateDeviceLegalHoldState (CallingContext callingContext, UpdateDeviceLegalHoldStateInput input, out UpdateDeviceLegalHoldStateResult result);

Data structure

The input to UpdateDeviceLegalHoldState is deviceId and the state of the hold for the device. LegalHoldComment and AuditComment are optional inputs.

[DataContract]
public class UpdateDeviceLegalHoldStateInput
{
    public UpdateDeviceLegalHoldStateInput()
    {
    }

    [DataMember]
    public Guid DeviceId;

    [DataMember]
    public bool EnableLegalHold;

    [DataMember]
    public string AuditComment;

    [DataMember]
    public string LegalHoldComment;
}

Result

The result is the BaseServiceResult described in General API structure.

[DataContract]
public class UpdateDeviceLegalHoldStateResult : BaseServiceResult
{
    public UpdateDeviceLegalHoldStateResult()
    {
    }
}