Add-VBOBackupApplication
Short Description
Adds backup application settings to an application pool.
Syntax
Add-VBOBackupApplication -Organization <VBOOrganization> -BackupApplications <VBOBackupApplication[]> [<CommonParameters>] |
Detailed Description
This cmdlet adds backup application settings to an application pool.
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 |
---|---|---|---|---|---|
Organization | Specifies a Microsoft organization. The cmdlet will add backup application settings to the specified Microsoft organization. | Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet. | True | Named | True (ByValue) |
BackupApplications | Specifies an array of backup applications. The cmdlet will add these backup applications to the Microsoft organization. | Accepts the VBOBackupApplication[] object. To create this object, run the New-VBOBackupApplication cmdlet. | True | Named | True (ByValue) |
<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 contains backup application settings that are added to Microsoft organizations.
Example
Adding Backup Application to Microsoft Organization
This example shows how to add a backup application to an application pool of Microsoft organization.
$securepassword = Read-Host "Enter your password" -AsSecureString Enter your password: ********** $org = Get-VBOOrganization $app = Get-VBOApplication -Organization $org $newApp = New-VBOBackupApplication -Application $app -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword Add-VBOBackupApplication -Organization $org -BackupApplications $newApp |
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. Save the result to the $app variable.
- Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $newApp variable.
- Run the Add-VBOBackupApplication cmdlet. Set the $org variable as the Organization parameter value. Set the $newApp variable as the BackupApplications parameter value.
Related Commands