Set-VBORestorePortalSettings

Short Description

Modifies connection settings to access Restore Portal.

Syntax

Set-VBORestorePortalSettings [-EnableService <SwitchParameter>] [-ApplicationId <Guid>] [-CertificateFilePath <String>] [-Region <VBOOffice365Region>] [-CertificatePassword <SecureString>] [-PortalUri <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies connection settings to access Restore Portal. These settings specify whether Restore Portal is enabled, an identification number of Azure AD application configured to access Restore Portal and an SSL certificate used for data exchange.

To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Set-VBORestorePortalSettings Note

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

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
EnableService	Defines that the cmdlet will enable Restore Portal.	SwitchParameter	False	Named	False	False
ApplicationId	Specifies Azure AD application ID. The cmdlet will use an application with this ID to connect to Restore Portal.	Guid	False	Named	False	False
CertificateFilePath	Specifies a path to the SSL certificate file.	String	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
CertificatePassword	Specifies a password for the SSL certificate.	SecureString	False	Named	False	False
PortalUri	Specifies web address of a machine with the Veeam Backup for Microsoft 365 REST API component installed. Before you add URI, consider the following restrictions: The website is available over HTTPS protocol only. By default, port 4443 must be opened on the Veeam Backup for Microsoft 365 server or a machine with the Veeam Backup for Microsoft 365 REST API component installed. The web address must be specified in one of the following formats: https://<IPv4 address>:<port number>, where <IPv4 address> is a public IPv4 address of a machine with the Veeam Backup for Microsoft 365 REST API component installed. https://<DNS hostname>:<port number>, where <DNS hostname> is DNS hostname of a machine with the Veeam Backup for Microsoft 365 REST API component installed.	String	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-VBORestorePortalSettings Example 1. Modifying Authentication Settings to Access Restore Portal

This example shows how to modify connection settings to access Restore Portal:

Change identification number of Azure AD application.
Locate the SSL certificate file and specify the certificate password.
Specify web address to open Restore Portal in a web browser window.

$plainpassword = "Password1234plain"

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

Set-VBORestorePortalSettings -EnableService -ApplicationId 98ce1588-597b-4e24-be7c-8a7f9fda41d4 -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword -PortalUri "https://portal.abc.com:4443"

Perform the following steps:

Assign the 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-VBORestorePortalSettings cmdlet. Specify the following settings:

Provide the EnableService parameter.
Specify the ApplicationId parameter value.
Specify the CertificateFilePath parameter value.
Set the $securepassword variable as the CertificatePassword parameter value.
Specify the PortalUri parameter value.

Related Commands

ConvertTo-SecureString