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.
- Modify a description of the Microsoft organization.
- 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 <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 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.
|
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 |
Description | Specifies a description of a Microsoft organization. The cmdlet will replace the current description of the organization. | String | False | Named | False | False |
Name | Specifies a name of the 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 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 | 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:
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:
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. | 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 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 | 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 | 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 credentials that you want to use for authenticating to on-premises components. You must specify the organization user name in one of the following formats:
| 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 | 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:
| VBOOrganizationType | False | Named | False | False |
Office365Region | Note: This parameter is obsolete. Specifies Microsoft Azure region where Microsoft 365 organization datacenter is located:
Default: Worldwide | VBOOffice365Region | False | Named | False | False |
Office365Credential | Note: This parameter is obsolete. Specifies credentials that you want to use for authenticating to Microsoft 365 organization. You must specify the organization user name in one of the following formats:
| 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:
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 credentials that 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
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.
Perform the following steps:
|
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.
Perform the following steps:
|
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.
Perform the following steps:
|
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.
Perform the following steps:
|
Related Commands