New-VBOBackupApplication

In this article

    Short Description

    Defines backup application settings to back up SharePoint and OneDrive for Business.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Defines settings of an existing backup application.

    New-VBOBackupApplication -Application <VBOApplication> -ApplicationCertificatePath <string> -ApplicationCertificatePassword <securestring>  [<CommonParameters>]

    • Define settings for a new backup application.

    New-VBOBackupApplication -Name <string> -Organization <VBOOrganization> -ApplicationCertificatePath <string> -ApplicationCertificatePassword <securestring> [-Count <int>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBOBackupApplication object that defines backup application settings. The backup application represents settings of an Azure AD application. You may want to use these settings to reduce throttling when you back up SharePoint and OneDrive for Business data.

    New-VBOBackupApplication Important

    • This cmdlet is available only in Veeam Backup for Microsoft Office 365 version 4c or later.
    • This cmdlet will run only for Microsoft organizations that are added to the Veeam Backup for Microsoft Office 365 infrastructure using modern app-only authentication method.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Application

    Specifies a backup application. The cmdlet will modify the settings of this application.

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

    True

    Named

    False

    ApplicationCertificatePath

    Specifies a path to the folder where the certificate is located. The cmdlet will use this certificate to set a backup application.

    String

    True

    Named

    False

    Name

    Specifies a name of a backup application. The cmdlet will set this name to the application.

    String

    True

    Named

    False

    Organization

    Specifies a Microsoft organization. The cmdlet will modify a backup application of this organization.

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

    True

    Named

    False

    ApplicationCertificatePassword

    Specifies the certificate password. The cmdlet will use this password to set a backup application.

    SecureString

    True

    Named

    False

    Count

    Specifies the number of backup applications. The cmdlet will create the specified number of applications.

    Int

    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 VBOBackupApplication object that defines backup application settings.

    Examples

    New-VBOBackupApplicationExample 1. Defining Settings of New Backup Application

    This example shows how to define settings of a new backup application.

    $securepassword = Read-Host "Enter your password" -AsSecureString

    Enter your password: **********

    $org = Get-VBOOrganization

    $app = Get-VBOApplication -Organization $org

    New-VBOBackupApplication -Application $app -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

    Perform the following steps:

    1. Specify the secure password:
    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    1. Get an application:
    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the Get-VBOApplication cmdlet. Set the $org variable as the Organization parameter value.
    1. Run the New-VBOBackupApplication cmdlet. Specify the following settings:
    • Set the $app variable as the Application parameter value.
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.

    New-VBOBackupApplicationExample 2. Defining Settings of Existing Backup Application

    This example shows how to define settings of an existing backup application.

    $securepassword = Read-Host "Enter your password" -AsSecureString

    Enter your password: **********

    $org = Get-VBOOrganization

    New-VBOBackupApplication -Name "BackupApp09" -Organization $org -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

    Perform the following steps:

    1. Specify the secure password:
    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the New-VBOBackupApplication cmdlet. Specify the following settings:
    • Specify the Name parameter value.
    • Set the $org variable as the Organization parameter value.
    • Specify the ApplicationCertificatePath parameter value.
    • Specify the ApplicationCertificatePassword parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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