Backup-CrmInstance
Initiates a back up a Dataverse environment.
Syntax
Backup-CrmInstance
-InstanceId <Guid>
-Label <String>
[-Notes <String>]
[-ApiUrl] <Uri>
[[-Credential] <PSCredential>]
[-TenantId <Guid>]
[-MaxCrmConnectionTimeOutMinutes <Int32>]
[-NonInteractive]
[<CommonParameters>] Description
The Backup-CrmInstance cmdlet initiates a back up of a Dataverse environment.
Examples
Example 1
PS C:\> Backup-CrmInstance -ApiUrl $connectionhost -Credential $cred -InstanceId <Guid> -Label "BackupLabel" -Notes "Notes on backup"Backs up the environment based on the information specified in the command parameters.
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 |
-InstanceId
Id for the specific Dataverse environment that you want to make a backup. Use the Get-CrmInstances cmdlet to find all Ids within the same tenant.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Label
Add a label to use to reference the backup.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-NonInteractive
Set to indicate a headless, non-interactive session that will not invoke a prompt, such as when authenticating and multi-factor authentication (MFA) is required.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Notes
Add comments about the backup.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TenantId
Tenant ID to use for creating the authentication token, which is required for client Id and client secret authentication type.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
System.Object