Get-CrmInstanceBackups
Retrieves all backups for a Dataverse environment.
Syntax
Get-CrmInstanceBackups
-InstanceId <Guid>
[-ApiUrl] <Uri>
[[-Credential] <PSCredential>]
[-TenantId <Guid>]
[-MaxCrmConnectionTimeOutMinutes <Int32>]
[-NonInteractive]
[<CommonParameters>]
Description
The Get-CrmInstanceBackups cmdlet retrieves all backups for a Dataverse environment.
Examples
Example 1
PS C:\> Get-CrmInstanceBackups -ApiUrl $connectionhost -InstanceId <Guid> -Credential $cred
Returns a list of all backups for the environment as indicated by the InstanceId parameter.
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. 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 |
-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 |
-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 |
Inputs
System.Guid
System.Uri System.Management.Automation.PSCredential System.Int32
Outputs
System.Object