Add-VBOOrganization - Veeam Backup for Microsoft 365 PowerShell Reference

Add-VBOOrganization [-Name <String>] [-Description <String>][-Office365ExchangeConnectionsSettings <VBOOffice365ConnectionSettings>][-Office365SharePointConnectionsSettings <VBOOffice365ConnectionSettings>][-OnPremExchangeConnectionSettings <VBOExchangeOnPremConnectionSettings>][-OnPremSharePointConnectionSettings <VBOSharePointOnPremConnectionSettings>] [-Region <VBOOffice365Region>][-VeeamAADApplicationUsed] [-EnableOffice365Teams] [-EnableTeamsChats] [<CommonParameters>]

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Name	Specifies a name of the Microsoft organization. The cmdlet will add an organization with this name.	String	False	Named	False
Description	Specifies a description of the Microsoft organization.	String	False	Named	False
Office365ExchangeConnectionsSettings	Specifies connection settings. The cmdlet will use these settings to add Microsoft Exchange Online to Veeam Backup for Microsoft 365. Note: If you also want to add Microsoft SharePoint Online to the same Microsoft 365 organization, you must set the VBOOffice365ConnectionSettings object to the same type of authentication mode.	Accepts the VBOOffice365ConnectionSettings object. To create this object, run the New-VBOOffice365ConnectionSettings cmdlet.	False	Named	False
Office365SharePointConnectionsSettings	Specifies connection settings. The cmdlet will use these settings to add Microsoft SharePoint Online and Microsoft OneDrive for Business to Veeam Backup for Microsoft 365. Note: If you also want to run the cmdlet with the Office365ExchangeConnectionsSettings parameter, you must set the VBOOffice365ConnectionSettings object to the same type of authentication mode.	Accepts the VBOOffice365ConnectionSettings object. To create this object, run the New-VBOOffice365ConnectionSettings cmdlet.	False	Named	False
OnPremExchangeConnectionSettings	Specifies connection settings. The cmdlet will use these settings to add Microsoft on-premises Exchange organization to Veeam Backup for Microsoft 365.	Accepts the VBOExchangeOnPremConnectionSettings object. To create this object, run the New-VBOOnPremConnectionSettings cmdlet.	False	Named	False
OnPremSharePointConnectionSettings	Specifies connection settings. The cmdlet will use these settings to add Microsoft on-premises SharePoint organization to Veeam Backup for Microsoft 365.	Accepts the VBOSharePointOnPremConnectionSettings object. To create this object, run the New-VBOOnPremConnectionSettings cmdlet.	False	Named	False
Region	Specifies Microsoft Entra region where Microsoft 365 organization datacenter is located: China Germany USDefence USGovernment Worldwide Default: Worldwide	VBOOffice365Region	False	Named	False
VeeamAADApplicationUsed	Defines that the cmdlet will use the Veeam application to connect to Microsoft Graph. Note: You must set this parameter to true for the following Microsoft Entra regions: China Germany Default: False	SwitchParameter	False	Named	False
EnableOffice365Teams	Defines that the cmdlet will add Microsoft Teams to Veeam Backup for Microsoft 365. To do this, the cmdlet will use settings specified with the Office365SharePointConnectionsSettings parameter. Default: True Note: If you want to use this parameter, you must also provide the Office365ExchangeConnectionsSettings and Office365SharePointConnectionsSettings parameters.	SwitchParameter	False	Named	False
EnableTeamsChats	For Microsoft organizations with modern app-only authentication. Defines that the cmdlet will enable backup of team chats. Default: False	SwitchParameter	False	Named	False

This example shows how to add a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure to back up the following services:

Microsoft Exchange Online.
Microsoft SharePoint Online and Microsoft OneDrive for Business.
Microsoft Teams and team chats.

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

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

$appSettings = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword -ApplicationId 6c957a12-93fd-469a-86f6-1dc3cc81cf07 -ConfigureApplication

Add-VBOOrganization -Office365ExchangeConnectionsSettings $appSettings -Office365SharePointConnectionsSettings $appSettings -EnableTeamsChats

WARNING: To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CHYX3QM33 to authenticate.

Perform the following steps:

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 New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Specify the ApplicationCertificatePath, ApplicationCertificatePassword, ApplicationId and ConfigureApplication parameters. Save the result to the $appSettings variable.
Run the Add-VBOOrganization cmdlet. Set the $appSettings variable as the Office365ExchangeConnectionsSettings parameter value. Set the $appSettings variable as the Office365SharePointConnectionsSettings parameter value. Provide the EnableTeamsChats parameter.
Open the https://microsoft.com/devicelogin webpage in a browser and provide the authentication code that you get in the warning output.

This example shows how to add a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure and define settings of a Microsoft Entra application using the certificate.

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

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

$newapp = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword -NewApplicationName "Application05"

Add-VBOOrganization -Office365ExchangeConnectionsSettings $newapp -Office365SharePointConnectionsSettings $newapp

WARNING: To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CHYX3QM33 to authenticate.

Perform the following steps:

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 New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Specify the ApplicationCertificatePath, ApplicationCertificatePassword and NewApplicationName parameters. Save the result to the $newapp variable.
Run the Add-VBOOrganization cmdlet. Set the $newapp variable as the Office365ExchangeConnectionsSettings parameter value. Set the $newapp variable as the Office365SharePointConnectionsSettings parameter value.
Open the https://microsoft.com/devicelogin webpage in a browser and provide the authentication code that you get in the warning output.

This example shows how to add a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure.

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

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

$appSettings = New-VBOOffice365ApplicationOnlyConnectionSettings -OfficeOrganizationName @tech-365.tech -ApplicationId 22b5dd21-5ccf-4696-8482-eda0a1c7d32b -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

Add-VBOOrganization -Office365SharePointConnectionsSettings $appSettings

Perform the following steps:

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 New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Specify the OfficeOrganizationName, ApplicationId, ApplicationCertificatePath, ApplicationCertificatePassword parameters. Save the result to the $appSettings variable.
Run the Add-VBOOrganization cmdlet. Set the $appSettings variable as the Office365SharePointConnectionsSettings parameter value.

This example shows how to add a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure. Veeam Backup for Microsoft 365 will back up Microsoft Exchange Online.

$credentials = Get-Credential

$connection = New-VBOOffice365ConnectionSettings -Credential $Credentials -GrantRolesAndPermissions

Add-VBOOrganization -Name "ABC Organization" -Office365ExchangeConnectionsSettings $connection

Perform the following steps:

Run the Get-Credential cmdlet. Enter credentials. Save the result to the $credentials variable.

Run the New-VBOOffice365ConnectionSettings cmdlet. Set the $credentials as the Credential parameter value. Provide the GrantRolesAndPermissions parameter. Save the result to the $connection variable.
Run the Add-VBOOrganization cmdlet. Specify the Name parameter value. Set the $connection variable as the Office365ExchangeConnectionsSettings parameter value.

This example shows how to add a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure to back up the following services:

Microsoft Exchange Online.
Microsoft SharePoint Online and Microsoft OneDrive for Business.

$credentials = Get-Credential

$connection = New-VBOOffice365ConnectionSettings -Credential $Credentials -GrantRolesAndPermissions

Add-VBOOrganization -Name "ABC Organization" -Office365ExchangeConnectionsSettings $connection -Office365SharePointConnectionsSettings $connection

Perform the following steps:

Run the Get-Credential cmdlet. Enter credentials. Save the result to the $credentials variable.
Run the New-VBOOffice365ConnectionSettings cmdlet. Set the $credentials as the Credential parameter value. Provide the GrantRolesAndPermissions parameter. Save the result to the $connection variable.
Run the Add-VBOOrganization cmdlet. Specify the following settings:

Specify the Name parameter value.
Set the $connection variable as the Office365ExchangeConnectionsSettings parameter value.
Set the $connection variable as the Office365SharePointConnectionsSettings parameter value.

This example shows how to add an on-premises Microsoft organization to back up Microsoft Exchange server.

$Credentials = Get-Credential

$onPremSettings = New-VBOOnPremConnectionSettings -Credential $Credentials -ServerName Support.North

Add-VBOOrganization -Name "ABC Organization" -OnPremExchangeConnectionSettings $onPremSettings

Perform the following steps:

Run the Get-Credential cmdlet. Enter credentials you want to use for authenticating to a Microsoft Exchange on-premises organization. Save the result to the $Credentials variable.
Run the New-VBOOnPremConnectionSettings cmdlet. Set the $Credentials variable as the Credential parameter value. Specify the ServerName parameter value. Save the result to the $onPremSettings variable.
Run the Add-VBOOrganization cmdlet. Specify the Name parameter value. Set the $onPremSettings variable as the OnPremExchangeConnectionSettings parameter value.