Set-VBOOffice365ApplicationOnlyConnectionSettings

In this article

    Short Description

    Modifies Azure AD application settings.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Modify Azure AD application settings that was added with a user name of a Microsoft Exchange user.

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings <VBOApplicationOnlyConnectionSettings> [-ApplicationId <Guid>] [-ApplicationCertificatePath <String>] [-ApplicationCertificatePassword <SecureString>] [-ConfigureApplication [<SwitchParameter>]] [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]<CommonParameters>]

    • Modify Azure AD application settings that was added using Microsoft Office 365 organization name.

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings <VBOApplicationOnlyConnectionSettings> [-ImpersonationAccountName <String>] [-ApplicationId <Guid>] [-ApplicationCertificatePath <String>][-ApplicationCertificatePassword <SecureString>] [-ConfigureApplication [<SwitchParameter>]] [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    • Modify new Azure AD application settings that was added with application ID and a new application certificate path.

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings <VBOApplicationOnlyConnectionSettings> [-OfficeOrganizationName <String>] [-ApplicationId <Guid>] [-ApplicationCertificatePath <String>][-ApplicationCertificatePassword <SecureString>] [-ConfigureApplication [<SwitchParameter>]][-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    • Modify new Azure AD application settings that was added using a new certificate path.

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings <VBOApplicationOnlyConnectionSettings> [-ApplicationCertificatePath <String>] [-ApplicationCertificatePassword <SecureString>] [-NewApplicationName <String>] [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies Azure AD application settings. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Set-VBOOffice365ApplicationOnlyConnectionSettings Important

    This cmdlet is available only in Veeam Backup for Microsoft Office 365 version 4c or later.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Settings

    Specifies Azure AD application settings. The cmdlet will modify these settings.

    Accepts the VBOApplicationOnlyConnectionSettings object. To create this object, run the New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet.

    True

    Named

    True (ByValue)

    ApplicationId

    Specifies an Azure AD application ID. The cmdlet will use this application ID to set up a secure connection to a Microsoft organization,

    Guid

    False

    Named

    False

    ApplicationCertificatePath

    Specifies a path to the folder where the certificate is located. The cmdlet will import the certificate that is located in this path to set up an encrypted connection to a Microsoft organization.

    String

    False

    Named

    False

    ApplicationCertificatePassword

    Specifies the certificate password. The cmdlet will use this password to confirm the certificate that you want to import to an Azure AD application.

    SecureString

    False

    Named

    False

    NewApplicationName

    Specifies a name of a new Azure AD application. The cmdlet will define Azure AD application settings with this name.

    String

    False

    Named

    False

    OfficeOrganizationName

    Specifies a name of Microsoft Office 365 organization. The cmdlet will use this name to authenticate against the Microsoft Office 365 server.

    String

    False

    Named

    False

    ImpersonationAccountName

    Specifies a user name of a Microsoft Exchange user. The cmdlet will use this user name to authenticate against the Microsoft Exchange server.

    String

    False

    Named

    False

    ConfigureApplication

    Defines that the cmdlet will configure settings of an existing Azure AD application.

    SwitchParameter

    False

    Named

    False

    SharePointSaveAllWebParts

    Defines that the cmdlet will add SharePoint Web Parts to Azure AD application settings.

    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.

    Output Object

    The cmdlet returns the VBOApplicationOnlyConnectionSettings object that defines Azure AD application settings.

    Examples

    Set-VBOOffice365ApplicationOnlyConnectionSettingsExample 1. Modifying Microsoft Exchange User Name of Azure AD Application Settings

    This example shows how to modify a user name of a Microsoft Exchange user added to Azure AD application settings. The cmdlet will replace the Office365Admin@tech-365.tech user name with the Administratortech@tech-365.tech user name.

    $securepassword = Read-Host "Enter your password" -AsSecureString

    Enter your password: **********

    $newAppSettings = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword -ApplicationId 6c957a12-93fd-469a-86f6-1dc3cc81cf07 -ImpersonationAccountName Office365Admin@tech-365.tech

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings $newAppSettings -ImpersonationAccountName Administratortech@tech-365.tech

    Perform the following steps:

    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    3. Run the New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Specify the ApplicationCertificatePath, ApplicationCertificatePassword, ApplicationId, and ImpersonationAccountName parameters.
    4. Run the Set-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Set the $newAppSettings variable as the Settings parameter value. Specify the ImpersonationAccountName parameter value.

    Set-VBOOffice365ApplicationOnlyConnectionSettingsExample 2. Modifying Microsoft Office 365 Organization Name of Azure AD Application Settings

    This example shows how to define a name of a Microsoft Office 365 organization of Azure AD application settings. The cmdlet will replace the @admin-365.tech organization name with the Administrator-365.tech organization name.

    $securepassword = Read-Host "Enter your password" -AsSecureString

    Enter your password: **********

    $newAppSettings = New-VBOOffice365ApplicationOnlyConnectionSettings -OfficeOrganizationName @admin-365.tech -ApplicationId 22b5dd21-5ccf-4696-8482-eda0a1c7d32b -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

    Set-VBOOffice365ApplicationOnlyConnectionSettings -Settings $newAppSettings -OfficeOrganizationName @Administrator-365.tech

    Perform the following steps:

    1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
    2. Enter the password.
    3. Run the New-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Specify the OfficeOrganizationName, ApplicationId, ApplicationId, and ApplicationCertificatePath and ApplicationCertificatePassword parameters.
    1. Run the Set-VBOOffice365ApplicationOnlyConnectionSettings cmdlet. Set the $newAppSettings variable as the Settings parameter value. Specify the OfficeOrganizationName parameter value.

    Related Commands