Set-VBOOrganization

Short Description

Modifies Microsoft organization settings.

Syntax

This cmdlet provides parameter sets that allow you to:

Modify a name of the Microsoft organization.

Set-VBOOrganization -Organization <VBOOrganization> -Name <String> [<CommonParameters>]

Modify a description of the Microsoft organization.

Set-VBOOrganization -Organization <VBOOrganization> [-Description <String>] [<CommonParameters>]

Modify Microsoft organization and the specific services that are related to this organization.

Set-VBOOrganization -Organization <VBOOrganization> [-Name <String>] [-Office365ExchangeConnectionsSettings <VBOOffice365ConnectionSettings>] [-Office365SharePointConnectionsSettings <VBOOffice365ConnectionSettings>] [-Region <VBOOffice365Region>] [-VeeamAADApplicationUsed] [-OnPremExchangeConnectionSettings <VBOExchangeOnPremConnectionSettings>] [-OnPremSharePointConnectionSettings <VBOSharePointOnPremConnectionSettings>] [-EnableOffice365Exchange] [-EnableOffice365SharePoint] [-EnableOffice365Teams] [-EnableTeamsChats] [-EnableOnPremExchange] [-EnableOnPremSharePoint] [<CommonParameters>]

Modify auxiliary backup accounts of the specific Microsoft organization.

Set-VBOOrganization -Organization <VBOOrganization> [-BackupAccounts <VBOBackupAccount[]>] [<CommonParameters>]

Modify backup application settings of the specific Microsoft organization.

Set-VBOOrganization -Organization <VBOOrganization> [-BackupApplications <VBOBackupApplication[]>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of an organization added to the Veeam Backup for Microsoft 365 infrastructure. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOOrganization Important

You must set the Office365ExchangeConnectionsSettings and Office365SharePointConnectionsSettings parameters to the same type of the authentication mode — basic or modern.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Organization	Specifies a Microsoft organization. The cmdlet will modify settings of this Microsoft organization.	Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.	True	Named	True (ByValue)
Name	Specifies a name of the Microsoft organization. The cmdlet will replace the current name with the specified name.	String	True	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
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
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
EnableOffice365Exchange	Defines that the cmdlet will enable connection to the Exchange Online organization component. Default: False	SwitchParameter	False	Named	False
EnableOffice365SharePoint	Defines that the cmdlet will enable connection to the SharePoint Online organization component. Default: False	SwitchParameter	False	Named	False
EnableOffice365Teams	Defines that the cmdlet will enable connection to the Microsoft Teams organization component. Default: False	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
EnableOnPremExchange	Defines that the cmdlet will enable connection to the Microsoft on-premises Exchange organization component. Default: False	SwitchParameter	False	Named	False
EnableOnPremSharePoint	Defines that the cmdlet will enable connection to the Microsoft on-premises SharePoint organization component. Default: False	SwitchParameter	False	Named	False
BackupAccounts	Specifies an array of auxiliary backup accounts to back up SharePoint and OneDrive for Business. The cmdlet will modify settings of the specified auxiliary backup accounts.	Accepts the VBOBackupAccount[] object. To get this object, run the Get-VBOApplication cmdlet.	False	Named	False
BackupApplications	Specifies an array of backup application settings. The cmdlet will modify settings of the specified backup application accounts.	Accepts the VBOBackupApplication[] object. To create this object, run the New-VBOBackupApplication cmdlet.	False	Named	False
Description	Specifies a description of the Microsoft organization. The cmdlet will replace the current description with the specified description.	String	False	Named	False

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

Examples

Set-VBOOrganization Example 1. Modifying Services to Back Up SharePoint Online and OneDrive for Business

This example shows how to include SharePoint Online and OneDrive for Business service to a backup of the Microsoft organization.

$credentials = Get-Credential

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

$org = Get-VBOOrganization -Name "Atlanta"

Set-VBOOrganization -Organization $org -Office365ExchangeConnectionsSettings $connection -Office365SharePointConnectionsSettings $connection -EnableOffice365SharePoint

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 variable as the Credential parameter value. Provide the GrantRolesAndPermissions parameter. Save the result to the $connection variable.
Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Set-VBOOrganization cmdlet. Specify the following settings:

Set the $org variable as the Organization parameter value.
Set the $connection variable as the Office365ExchangeConnectionsSettings parameter value.
Set the $connection variable as the Office365SharePointConnectionsSettings parameter value.
Provide the EnableOffice365SharePoint parameter.

Set-VBOOrganization Example 2. Modifying Auxiliary Backup Accounts

This example shows how to modify the auxiliary backup accounts that are used to back up SharePoint and OneDrive for Business.

$org = Get-VBOOrganization

$group = Get-VBOOrganizationGroup -Organization $org -DisplayName "VBOWorkGroup"

$members = Get-VBOOrganizationGroupMember -Group $group

$pwd = ConvertTo-SecureString -String "Pa$$word123" -AsPlainText -Force

$account = New-VBOBackupAccount -SecurityGroupMember $members[0] -Password $pwd

$org = Get-VBOOrganization -Name "Atlanta"

Set-VBOOrganization -Organization $org -BackupAccounts $account

Perform the following steps:

Define settings of auxiliary backup accounts:

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the Get-VBOOrganizationGroup cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $group variable.
Run the Get-VBOOrganizationGroupMember cmdlet. Set the $group variable as the Group variable value. Save the result to the $members variable.
Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
Run the New-VBOBackupAccount cmdlet. Set the $members variable as the SecurityGroupMember parameter value. Set the $pwd variable as the Password parameter value. Save the result to the $pwd variable.

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $account variable as the BackupAccounts parameter value.

Set-VBOOrganization Example 3. Adding Array of Backup Applications to Veeam Backup for Microsoft 365

This example shows how to add an array of backup applications to the Veeam Backup for Microsoft 365 infrastructure.

$org = Get-VBOOrganization

$apps = Get-VBOApplication -Organization $org

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

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

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

$AppArray = $backupApp1,$backupApp2,$backupApp3

Set-VBOOrganization -Organization $org -BackupApplications $AppArray

Perform the following steps:

Get an array of Microsoft Entra applications:

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.

Modify backup application settings:

Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp1 variable.
Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp2 variable.
Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp3 variable.

Set the $AppArray variable value to the sequence of the $backupApp1, $backupApp2 and $backupApp3 variables.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $AppArray variable as the BackupApplications parameter value.

Set-VBOOrganization Example 4. Modifying Backup Application Settings

This example shows how to modify the existing backup application. The cmdlet will replace it with the new BackupApp09 backup application to back up SharePoint and OneDrive for Business.

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

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

$org = Get-VBOOrganization -Name "Atlanta"

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

Set-VBOOrganization -Organization $org -BackupApplications $backupApp

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 Name, Organization, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp variable.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $backupApp variable as the BackupApplications parameter value.

Related Commands