Add-VBRAzureComputeBackupCopyJob

In this article

    Short Description

    Creates Azure IaaS backup copy jobs.

    Applies to

    Product Edition: Enterprise Plus, Veeam Universal License

    Syntax

    Add-VBRAzureComputeBackupCopyJob -Backup <VBRAzureComputeBackup[]> [-Name <string>] [-Description <string>] [-Repository <CBackupRepository>] [-RecoveryPointObjective <VBRRecoveryPointObjective>] [-RetentionPolicy <VBRRetentionPolicy>] [-BackupWindowOptions <VBRBackupWindowOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates Azure IaaS backup copy jobs of Azure Virtual Machines that are stored on a Microsoft Azure Blob Storage repository. Azure IaaS backup copy jobs will copy the backups from Microsoft Azure Blob Storage external repositories to target repositories.

    Add-VBRAzureComputeBackupCopyJob Note:

    The cmdlet creates jobs in a disabled state. Run the Enable-VBRJob cmdlet to enable jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Backup

    Specifies an array of Azure backups that you want to copy.

    Accepts the VBRAzureComputeBackup[] object. To get this object, run the Get-VBRAzureComputeBackup cmdlet.

    True

    Named

    True (ByValue)

    Name

    Specifies a name of a backup copy job. The cmdlet will create the job with this name.

    String

    False

    Named

    False

    Description

    Specifies a description of a backup copy job. The cmdlet will create the job with this description.

    String

    False

    Named

    False

    Repository

    Specifies a target backup repository. The cmdlet will copy Azure backups to this repository.

    Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    False

    Named

    False

    RecoveryPointObjective

    Specifies a backup copy interval. The cmdlet will copy new restore points of Azure IaaS backup copy jobs to the target backup repository.

    Accepts the VBRRecoveryPointObjective object. To create this object, run the New-VBRRecoveryPointObjective cmdlet.

    False

    Named

    False

    RetentionPolicy

    Specifies a number of restore points to keep on a target backup repository.

    Accepts the VBRRetentionPolicy object. To get this object, run the following cmdlets:

    False

    Named

    False

    BackupWindowOptions

    Specifies the period of time when a backup copy job is allowed to run.

    Accepts the VBRBackupWindowOptions object. To get this object, run the New-VBRBackupWindowOptions cmdlet.

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBRAzureComputeBackupCopyJob object that contains an array of Azure IaaS backup copy jobs.

    Examples

    Creating Azure Backup Copy Job

    This example shows how to create an Azure backup copy job.

    $backup = Get-VBRAzureComputeBackup -Name "November report"

    Add-VBRAzureComputeBackupCopyJob -Backup $backup

    Perform the following steps:

    1. Run the Get-VBRAzureComputeBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Add-VBRAzureComputeBackupCopyJob cmdlet. Set the $backup variable as the Backup parameter value.

    Related Commands

    Get-VBRAzureComputeBackup

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.