New-VBOBackupApplication

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 <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBOBackupApplication object that defines backup application settings. The backup application represents settings of an Azure AD application.

New-VBOBackupApplication Important

This cmdlet will run only for Microsoft organizations that are added to the Veeam Backup for Microsoft 365 infrastructure using modern app-only authentication method.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
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	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	False
Name	Specifies a name of the backup application. The cmdlet will set this name to the application.	String	True	Named	False	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	False
ApplicationCertificatePassword	Specifies the certificate password. The cmdlet will use this password to set a backup application.	SecureString	False	Named	False	False
Count	Specifies the number of backup applications. The cmdlet will create the specified number of applications.	Int32	False	Named	False	False

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-VBOBackupApplication Example 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:

Specify the secure password:

Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
Enter the password.

Get an application:

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the Get-VBOApplication cmdlet. Set the $org variable as the Organization parameter value.

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-VBOBackupApplication Example 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:

Specify the secure password:

Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
Enter the password.

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
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