Set-VBOTenantAuthenticationSettings

Short Description

Modifies the Veeam Backup for Microsoft 365 tenant authentication settings.

Syntax

Set-VBOTenantAuthenticationSettings [-EnableAuthentication] [-CertificateFilePath <String>]

[-CertificatePassword <SecureString>] [<CommonParameters>]

Detailed Description

This cmdlet modifies tenant authentication settings configured for Veeam Backup for Microsoft 365. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Note

This cmdlet accepts the SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
CertificateFilePath	Specifies a path to the tenant authentication certificate file.	`String`	False	Named	False
CertificatePassword	Specifies a password for the tenant authentication certificate.	`SecureString`	False	Named	False
EnableAuthentication	Defines that the cmdlet will enable tenant authentication to the Veeam Backup for Microsoft 365 server with organization credentials. Default: False	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOTenantAuthenticationSettings object that contains the Veeam Backup for Microsoft 365 tenant authentication settings.

Examples

Modifying Tenant Authentication Settings

This example shows how to modify tenant authentication settings.

$plainpassword = "Password1234plain"

$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

Set-VBOTenantAuthenticationSettings -EnableAuthentication -CertificateFilePath "C:\cert.pfx" -CertificatePassword $securepassword

Perform the following steps:

Assign your certificate password to the $plainpassword variable.
Run the ConvertTo-SecureString cmdlet with the $plainpassword variable to turn the password into the SecureString type. Save the result to the $securepassword variable.
Run the Set-VBOTenantAuthenticationSettings cmdlet with the $securepassword variable and EnableAuthentication parameter.

ConvertTo-SecureString