This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBORestorePortalSettings

Short Description

Modifies connection settings to access Restore Portal.

Syntax

Set-VBORestorePortalSettings [-EnableService [<switchparameter>]] [-ApplicationId <guid>] [-CertificateFilePath <string>] [-Region <VBOOffice365Region>] [-CertificatePassword <securestring>]  [<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 an application ID. The cmdlet will use an application 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

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

VBOOffice365Region

False

Named

False

False

CertificatePassword

Specifies a password for the SSL certificate.

SecureString

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-VBORestorePortalSettingsExample 1. Modifying Authentication Settings to Access Restore Portal

Related Commands

ConvertTo-SecureString