Share via

Reset-CrmInstance

  • Reference
Module:
Microsoft.Xrm.OnlineManagementAPI

Resets a sandbox environment to delete and re-provision it.

Syntax

Reset-CrmInstance
     -TargetInstanceIdToReset <Guid>
     -ResetInstanceRequestDetails <ResetRequest>
     [-ApiUrl] <Uri>
     [[-Credential] <PSCredential>]
     [-MaxCrmConnectionTimeOutMinutes <Int32>]
     [<CommonParameters>]

Description

The Reset-CrmInstance cmdlet resets a sandbox environment to delete and re-provision it. Consider a reset when you want to:

  • Change to a different version of Dataverse.
  • Create a new project.
  • Free up storage space.
  • Remove an environment that contains personally identifiable information data.

Warning

  • The sandbox environment will be deleted and reset to factory settings. You will not be able to recover any deleted data.

Note

Only sandbox environments can be reset.

Examples

Example 1

PS C:\> Reset-CrmInstance -TargetInstanceIdToReset $TargetInstanceIdToReset -ResetInstanceRequestDetails $reqInfo

Resets the environment specified by the -TargetInstanceIdToReset parameter that contains the environment guid and the -ResetInstanceRequestDetails parameter, which is used for the re-provisioned environment properties and provided by the New-CrmInstanceResetRequestInfo cmdlet, such as friendly name, base language, and currency.

Parameters

-ApiUrl

URL of the Dataverse root service endpoint. For information about this parameter see Establish your credentials and connection.

Type:Uri
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Credential

User credential for signing in to Dataverse. For information about this parameter see Establish your credentials and connection.

Type:PSCredential
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MaxCrmConnectionTimeOutMinutes

Maximum number in minutes to wait before quitting the operation.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResetInstanceRequestDetails

Object created by using the New-CrmInstanceResetRequestInfo cmdlet that contains the information used to re-provision the environment.

Type:ResetRequest
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetInstanceIdToReset

Id for the specific Dataverse environment that you want to reset. Use the Get-CrmInstances cmdlet to find all environment Ids within the same tenant.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.Guid

Microsoft.Xrm.Services.Admin.Client.Models.ResetRequest

System.Uri

System.Management.Automation.PSCredential

System.Int32

Outputs

System.Object