Set-VBOOrganization

In this article

    Short Description

    Modifies Microsoft organization settings.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Modify a name of a Microsoft organization.

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

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

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

    • Modify auxiliary backup accounts of the specific organization.

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

    • Modify backup application settings of the specific organization.

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

    Detailed Description

    This cmdlet modifies settings of an organization added to 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

    Accept Wildcard Characters

    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)

    False

    Name

    Specifies a name of a Microsoft organization. The cmdlet will replace the current name with the specified name.

    String

    True

    Named

    False

    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

    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 script 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

    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

    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

    False

    Region

    Specifies Microsoft Azure region where Microsoft 365 organization datacenter is located:

    • China
    • Germany
    • USDefence
    • USGovernment
    • Worldwide

    Default: Worldwide

    VBOOffice365Region

    False

    Named

    False

    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 Azure Regions:

    • China
    • Germany

    Default: False

    SwitchParameter

    False

    Named

    False

    False

    EnableOffice365Exchange

    Defines that the cmdlet will enable connection to the Exchange Online organization component.

    SwitchParameter

    False

    Named

    False

    False

    EnableOffice365SharePoint

    Defines that the cmdlet will enable connection to the SharePoint Online organization component.

    SwitchParameter

    False

    Named

    False

    False

    EnableOffice365Teams

    Defines that the cmdlet will enable connection to the Microsoft Teams organization component.

    SwitchParameter

    False

    Named

    False

    False

    EnableTeamsChats

    For Microsoft organizations with modern app-only authentication.

    Defines that the cmdlet will enable backup of team chats using Protected APIs in Microsoft Teams.

    Note: This parameter is available starting from Veeam Backup for Microsoft 365 version 6a (build 6.1.0.222).

    SwitchParameter

    False

    Named

    False

    False

    EnableOnPremExchange

    Defines that the cmdlet will enable connection to the Microsoft on-premises Exchange organization component.

    SwitchParameter

    False

    Named

    False

    False

    EnableOnPremSharePoint

    Defines that the cmdlet will enable connection to the Microsoft on-premises SharePoint organization component.

    SwitchParameter

    False

    Named

    False

    False

    BackupAccounts

    Specifies an array of auxiliary backup account to back up SharePoint and OneDrive for Business. The cmdlet will modify settings of the specified auxiliary backup account.

    Accepts the VBOBackupAccount[] object.

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

    False

    Named

    False

    False

    BackupApplications

    Specifies an array of backup application settings. The cmdlet will modify settings of the specified backup application account.

    Accepts the VBOBackupApplication[] object.

    To create this object, run the New-VBOBackupApplication cmdlet.

    False

     

     

    Named

    False

    False

    ExchangeConfigureThrottlingPolicy

    Note: This parameter is obsolete.

    Defines that the cmdlet will enable the throttling policy. The cmdlet will set throttling policy to unlimited  for the account that you use to connect to Microsoft Exchange organization server..

    SwitchParameter

    False

    Named

    False

    False

    ExchangeOnPremisesCredential

    Note: This parameter is obsolete.

    Specifies the credentials you want to use for authenticating with on-premises components.

    You must specify the organization user name in one of the following formats:

    • Username@domain.com
    • User@domain.onmicrosoft.com

    PSCredential

    False

    Named

    False

    False

    ExchangeOnPremisesGrantImpersonation

    Note: This parameter is obsolete.

    Defines that backup jobs will be able to process all mailboxes within on-premises Microsoft Exchange organization.

    SwitchParameter

    False

    Named

    False

    False

    ExchangeServerName

    Note: This parameter is obsolete.

    Specifies Microsoft Exchange server EWS endpoint URL.

    String

    False

    Named

    False

    False

    ExchangeSkipCAVerification

    Note: This parameter is obsolete.

    For SSL connection.

    Defines that the cmdlet will skip Certificate Authority verification.

    SwitchParameter

    False

    Named

    False

    False

    ExchangeSkipCommonName
    Verification

    Note: This parameter is obsolete.

    For SSL connection.

    Defines that the cmdlet will skip Common Name verification.

    SwitchParameter

    False

    Named

    False

    False

    ExchangeSkipRevocationCheck

    Note: This parameter is obsolete.

    For SSL connection.

    Defines that the cmdlet will skip the check of certificate expiration against the certificate revocation list.

    SwitchParameter

    False

    Named

    False

    False

    ExchangeUseSSL

    Note: This parameter is obsolete.

    Defines that the cmdlet will set up a secure connection with Microsoft Exchange organization server.

    SwitchParameter

    False

    Named

    False

    False

    Type

    Note: This parameter is obsolete.

    Defines the type of the organization deployment:

    • Office365
    • On-premises
    • Hybrid

    VBOOrganizationType

    False

    Named

    False

    False

    Office365Region

    Note: This parameter is obsolete.

    Specifies Microsoft Azure region where Microsoft 365 organization datacenter is located:

    • Worldwide
    • USGovernment
    • Germany
    • China
    • USDefence

    Default: Worldwide

    VBOOffice365Region

    False

    Named

    False

    False

    Office365Credential

    Note: This parameter is obsolete.

    Specifies the credentials you want to use for authenticating with Microsoft 365 organization.

    You must specify the organization user name in one of the following formats:

    • Username@domain.com
    • User@domain.onmicrosoft.com

    PSCredential

    False

    Named

    False

    False

    Office365GrantImpersonation

    Note: This parameter is obsolete.

    Defines that backup jobs will be able to process all mailboxes within Microsoft 365 organization.

    SwitchParameter

    False

    Named

    False

    False

    Office365GrantAccessToSiteCollections

    Note: This parameter is obsolete.

    Defines that the cmdlet will assign user Site Collection Administrator rights for accessing site collections and sites.

    SwitchParameter

    False

    Named

    False

    False

    Office365UseVeeamAADApplication

    Note: This parameter is obsolete.

    Defines that the cmdlet will use Veeam application to connect to Microsoft Graph.

    Note: You must set this parameter to True for the following Microsoft Azure Regions:

    • China
    • Germany

    Default: False

    SwitchParameter

    False

    Named

    False

    False

    IsExchange

    Note: This parameter is obsolete.

    Defines if the selected organization contains Microsoft Exchange components.

    SwitchParameter

    False

    Named

    False

    False

    IsSharePoint

    Note: This parameter is obsolete.

    Defines if the selected organization contains Microsoft SharePoint components.

    SwitchParameter

    False

    Named

    False

    False

    SharePointServerName

    Note: This parameter is obsolete.

    Specifies SharePoint server name.

    String

    False

    Named

    False

    False

    SharePointServerPort

    Note: This parameter is obsolete.

    Specifies SharePoint server port.

    Int32

    False

    Named

    False

    False

    SharePointCredential

    Note: This parameter is obsolete.

    Specifies the credentials you want to use for authenticating to organization with SharePoint On-premises components.

    PSCredential

    False

    Named

    False

    False

    SharePointGrantAccessToSiteCollections

    Note: This parameter is obsolete.

    Defines if you choose to automatically grant required permissions and assign roles to gain access to SharePoint site collections.

    SwitchParameter

    False

    Named

    False

    False

    SharePointUseSSL

    Note: This parameter is obsolete.

    Defines that the cmdlet will use a secure connection with Microsoft SharePoint server.

    SwitchParameter

    False

    Named

    False

    False

    SharePointSkipCAVerification

    Note: This parameter is obsolete.

    For a secure connection.

    Defines that Certificate Authority verification check will not be performed.

    SwitchParameter

    False

    Named

    False

    False

    SharePointSkipCommonNameVerification

    Note: This parameter is obsolete.

    For a secure connection.

    Defines that common name verification check will not be performed.

    SwitchParameter

    False

    Named

    False

    False

    SharePointSkipRevocationCheck

    Note: This parameter is obsolete.

    For a secure connection.

    Defines that certificate revocation check will not be performed.

    SwitchParameter

    False

    Named

    False

    False

    <CommonParameters>

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

    Examples

    Set-VBOOrganizationExample 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:

    1. Run the Get-Credential cmdlet. Enter credentials. Save the result to the $credentials variable.
    1. 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.
    2. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
    3. 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-VBOOrganizationExample 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:

    1. Define settings of auxiliary backup accounts:
    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. 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.
    3. Run the Get-VBOOrganizationGroupMember cmdlet. Set the $group variable as the Group variable value. Save the result to the $members variable.
    4. Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
    5. 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.
    1. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
    2. Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $account variable as the BackupAccounts parameter value.

    Set-VBOOrganizationExample 3. Adding Array of Backup Application 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 (3).pfx" -ApplicationCertificatePassword $securepassword

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

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

    $AppArray = $backupApp1,$backupApp2,$backupApp3

    Set-VBOOrganization -Organization $org -BackupApplications $AppArray

    Perform the following steps:

    1. Get an array of Azure AD applications:
    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. Modify backup application settings:
    1. Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp1 variable.
    2. Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp2 variable.
    3. Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp3 variable.
    1. Set the $AppArray variable value to the sequence of the $backupApp1, $backupApp2 and $backupApp3 variables.
    2. Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $AppArray variable as the BackupApplications parameter value.

    Set-VBOOrganizationExample 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:

    1. Specify the secure password:
    1. 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.
    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 Name, Organization, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp variable.
    3. 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