Set-VBOOffice365ConnectionSettings

Short Description

Modifies connection settings to access Microsoft 365 organizations.

Syntax

This cmdlet provides parameter sets that allow you to:

Modify connection settings to access Microsoft 365 organizations using modern authentication with legacy protocols allowed by specifying an application secret.

Set-VBOOffice365ConnectionSettings -Settings <VBOOffice365LegacyConnectionSettings> [-AppCredential <PSCredential>] [-GrantRolesAndPermissions <SwitchParameter>] [-ApplicationId <Guid>] [-ApplicationSecret <SecureString>] [<CommonParameters>]

Modify connection settings to access Microsoft 365 organizations using modern authentication with legacy protocols allowed by specifying an application certificate.

Obsolete Cmdlet Set

The following cmdlet set is obsolete. It still works in Veeam Backup for Microsoft 365 7.0 but may not be supported in the next versions of Veeam Backup for Microsoft 365.

Set-VBOOffice365ConnectionSettings -Settings <VBOOffice365LegacyConnectionSettings> [-Credential <PSCredential>] [-GrantRolesAndPermissions <SwitchParameter>] [-VeeamAADApplicationUsed <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet modifies authentication settings to access Microsoft 365 organizations. You can apply these settings to add Microsoft 365 organizations 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.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Settings	Specifies the authentication settings that you want to modify.	Accepts the VBOOffice365LegacyConnectionSettings object. To create this object, run the New-VBOOffice365ConnectionSettings cmdlet.	True	Named	True (ByValue)	False
AppCredential	For the modern authentication type. Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft 365 organization.	PSCredential	False	Named	False	False
ApplicationCertificatePassword	For the modern authentication type. Specifies the certificate password. The cmdlet will use these credentials to connect to a Microsoft 365 organization.	SecureString	False	Named	False	False
ApplicationCertificatePath	For the modern authentication type. Specifies a path to the application certificate. The cmdlet will use this path to get the application certificate and to connect to a Microsoft 365 organization.	String	False	Named	False	False
ApplicationId	For the modern authentication type. Specifies an application ID. The cmdlet will use an application ID to connect to a Microsoft 365 organization.	Guid	False	Named	False	False
ApplicationSecret	For the modern authentication type. Specifies an application secret. The cmdlet will use an application secret to connect to a Microsoft 365 organization.	SecureString	False	Named	False	False
Credential	Note: This parameter is obsolete. Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft 365 organization.	PSCredential	False	Named	False	False
GrantRolesAndPermissions	Defines that the cmdlet will grant required permissions and assign appropriate roles to the account.	SwitchParameter	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

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

Examples

Set-VBOOffice365ConnectionSettings Example 1. Modifying Connection Settings with Basic Authentication

This example shows how to modify connection settings with the basic authentication of a Microsoft 365 organization with the name ABC.

$Credentials = Get-Credential

$Organization = Get-VBOOrganization -Name "ABC"

Set-VBOOffice365ConnectionSettings -Settings $Organization.Office365LegacyConnectionSettings -Credential $Credentials

Perform the following steps:

Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating to a Microsoft 365 organization. Save the result to the $Credentials variable.
Run the Get-VBOOrganization cmdlet to get an organization with the name ABC. Save the result to the $Organization variable.
Run the Set-VBOOffice365ConnectionSettings cmdlet with the $Organization.Office365LegacyConnectionSettings and $Credentials variables to modify the ABC organization connection settings.

Set-VBOOffice365ConnectionSettings Example 2. Modifying Connection Settings with Modern Authentication Using Application Secret

This example shows how to modify connection settings for a Microsoft 365 organization added using modern authentication with legacy protocols allowed by specifying an application secret.

$Credentials = Get-Credential

$Organization = Get-VBOOrganization -Name "ABC"

$ApplicationSecret = ConvertTo-SecureString -String "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s=" -AsPlainText -Force

Set-VBOOffice365ConnectionSettings -Settings $Organization.Office365LegacyConnectionSettings -AppCredential $Credentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationSecret $ApplicationSecret -GrantRolesAndPermissions

Perform the following steps:

Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating to a Microsoft 365 organization. Save the result to the $Credentials variable.
Run the Get-VBOOrganization cmdlet to get an organization with the name ABC. Save the result to the $Organization variable.
Run the ConvertTo-SecureString cmdlet with the AsPlainText parameter to turn the ApplicationSecret into the SecureString type. Save the result to the $ApplicationSecret variable.
Run the Set-VBOOffice365ConnectionSettings cmdlet with the $Credentials and $ApplicationSecret variables and the GrantRolesAndPermissions parameter to modify the ABC organization connection settings.

Set-VBOOffice365ConnectionSettings Example 3. Modifying Connection Settings with Modern Authentication Using Application Certificate

This example shows how to modify connection settings for a Microsoft 365 organization added using modern authentication with legacy protocols allowed by specifying an application certificate.

$Credentials = Get-Credential

$Organization = Get-VBOOrganization -Name "ABC"

$ApplicationCertificatePassword = ConvertTo-SecureString -String "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s=" -AsPlainText -Force

Set-VBOOffice365ConnectionSettings -Settings $Organization.Office365LegacyConnectionSettings -AppCredential $Credentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationCertificatePath "C:\ApplicationCertificate.pfx" -ApplicationCertificatePassword $ApplicationCertificatePassword

Perform the following steps:

Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating to a Microsoft 365 organization. Save the result to the $Credentials variable.
Run the Get-VBOOrganization cmdlet to get an organization with the name ABC. Save the result to the $Organization variable.
Run the ConvertTo-SecureString cmdlet with the AsPlainText parameter to turn the ApplicationCertificatePassword into the SecureString type. Save the result to the $ApplicationCertificatePassword variable.
Run the Set-VBOOffice365ConnectionSettings cmdlet with the $Credentials and $ApplicationCertificatePassword variables to modify the ABC organization connection settings.

Related Commands