Set-VBOOffice365ConnectionSettings

In this article

    Short Description

    Modifies connection settings to access Microsoft Office 365 organizations.

    Syntax

    This cmdlet provides the following parameter sets.

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

    Set-VBOOffice365ConnectionSettings -Settings <VBOOffice365ConnectionSettings> [-AppCredential <pscredential>] [-GrantRolesAndPermissions] [-ApplicationId <guid>] [-ApplicationSecret <securestring>]  [<CommonParameters>]

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

    Set-VBOOffice365ConnectionSettings -Settings <VBOOffice365ConnectionSettings> [-AppCredential <pscredential>] [-GrantRolesAndPermissions] [-ApplicationId <guid>] [-ApplicationCertificatePath <string>] [-ApplicationCertificatePassword <securestring>]  [<CommonParameters>]

    Obsolete Cmdlet Set

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

    Set-VBOOffice365ConnectionSettings -Settings <VBOOffice365ConnectionSettings> [-Credential <pscredential>] [-GrantRolesAndPermissions] [-VeeamAADApplicationUsed]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies authentication settings to access Microsoft Office 365 organizations. You can apply these settings to add Microsoft Office 365 organizations to Veeam Backup for Microsoft Office 365 infrastructure.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Settings

    Specifies the authentication settings that you want to modify.

    Accepts the VBOOffice365ConnectionSettings object.

    True

    Named

    True (ByValue)

    False

    AppCredential

    For the modern authentication type.

    Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft Office 365 organization.

    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 Office 365 organization.

    False

    Named

    False

    False

    ApplicationCertificatePath

    For the modern authentication type.

    Specifies the path to the application certificate. The cmdlet will use this path to get the application certificate and to connect to a Microsoft Office 365 organization.

    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 Office 365 organization..

    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 Office 365 organization.

    False

    Named

    False

    False

    Credential

    Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft Office 365 organization.

    False

    Named

    False

    False

    GrantRolesAndPermissions

    Indicates that the cmdlet will grant required permissions and assign appropriate roles to the account.

    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 the True value for the following Microsoft Azure Regions:

    • China
    • Germany

    Default: False

    SwitchParameter

    False

    Named

    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

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

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

    $Credentials = Get-Credential

    $Organization = Get-VBOOrganization -Name "ABC"

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

    Example 2

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

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

    $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.Office365ExchangeConnectionSettings -AppCredential $Credentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationSecret $ApplicationSecret

    Example 3

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

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

    $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.Office365ExchangeConnectionSettings -AppCredential $Credentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationCertificatePath "C:\ApplicationCertificate.pfx" -ApplicationCertificatePassword $ApplicationCertificatePassword

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.