New-VBOOffice365ApplicationOnlyConnectionSettings

In this article

    Short Description

    Defines Azure AD application settings.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Define Azure AD application settings with a user name of a Microsoft Exchange user.

    New-VBOOffice365ApplicationOnlyConnectionSettings -ImpersonationAccountName <String> -ApplicationId <Guid> -ApplicationCertificatePath <String> -ApplicationCertificatePassword <SecureString> [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    • Define Azure AD application settings using Microsoft Office 365 organization name.

    New-VBOOffice365ApplicationOnlyConnectionSettings -OfficeOrganizationName <String> -ApplicationId <Guid> -ApplicationCertificatePath <String> -ApplicationCertificatePassword <SecureString> [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    • Define new Azure AD application settings using application ID and a new application certificate path.

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

    • Define new Azure AD application settings using a new certificate path.

    New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationCertificatePath <String> -ApplicationCertificatePassword <SecureString> [-NewApplicationName <String>] [-SharePointSaveAllWebParts [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBOOffice365ApplicationOnlyConnectionSettings object. This object defines Azure AD application settings that allow you to use modern app-only authentication when you add Microsoft organizations to the Veeam Backup for Microsoft Office 365 infrastructure. Depending on your setup you can define Azure AD application settings using the following options:

    • Define Azure AD application settings without authentication code. Use this option to define an Azure AD application without using an authentication code. To authenticate against a Microsoft Office 365 server you must provide a Microsoft Exchange user name. The cmdlet will not configure Azure AD application settings.
    • Define Azure AD application settings using Microsoft Office 365 organization name. Use this option to define an Azure AD application that you will use to back up only Microsoft SharePoint Online and Microsoft OneDrive for Business services. To authenticate against Microsoft Office 365 server you must provide a Microsoft Office 365 organization name. The cmdlet will not configure Azure AD application settings.
    • Define new Azure AD application settings using application ID and a new application certificate path. Use this option to register new Azure AD application settings.
    • Define new Azure AD application settings using a certificate. Use this option to configure Azure AD application without specifying the application ID settings.

    New-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

    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

    True

    Named

    True

    OfficeOrganizationName

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

    String

    True

    Named

    True

    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

    True

    Named

    True

    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

    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

    True

    Named

    False

    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

    True

    Named

    True

    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

    New-VBOOffice365ApplicationOnlyConnectionSettingsExample 1. Defining Azure AD Application Settings with User Name of Microsoft Exchange User

    This example shows how to define Azure AD application settings using the Office365Admin@tech-365.tech user name to authenticate to the Microsoft Office 365 server.

    $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

    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 following settings:
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePath parameter value.
    • Specify the ApplicationId parameter value.
    • Specify the ImpersonationAccountName parameter value.
    • Save the result to the $newAppSettings variable.

    New-VBOOffice365ApplicationOnlyConnectionSettingsExample 2. Defining Azure AD Application Settings Using Microsoft 365 Organization Name

    This example shows how to define Azure AD application settings. The cmdlet will use the @tech-365.tech name to authenticate against the Microsoft Office 365 server. The cmdlet will not configure Azure AD application settings.

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

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

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

    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 following settings:
    • Specify the OfficeOrganizationName parameter value.
    • Specify the ApplicationId parameter value.
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.
    • Save the result to the $newAppSettings variable.
    1. To set up a secure connection to a Microsoft organization, open the https://microsoft.com/devicelogin link in your browser and enter the code that you get in the PowerShell Console to authenticate to the Microsoft Office 365 server.

    New-VBOOffice365ApplicationOnlyConnectionSettingsExample 3. Defining New Azure AD Application Settings

    This example shows how to define new Azure AD application settings. The cmdlet will add this application to the Azure AD.

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

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

    $newAppSettings = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationId "f5df82a6-e9ea-4430-ae9b-9b3373f405c6" -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

    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 following settings:
    • Specify the ApplicationId parameter value.
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.
    • Save the result to the $newAppSettings variable.

    New-VBOOffice365ApplicationOnlyConnectionSettingsExample 4. Defining Settings of Existing Azure AD Application

    This example shows how to define settings of an existing Azure AD application.

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

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

    $configApp = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationId a22f2e50-0e00-4f24-b09d-ccd161e136bf -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword -ConfigureApplication

    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 following settings:
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.
    • Specify the ApplicationId parameter value.
    • Provide the ConfigureApplication parameter.
    • Save the result to the $configApp variable.

    New-VBOOffice365ApplicationOnlyConnectionSettingsExample 5. Defining Azure AD Application Using Certificate

    This example shows how to define settings of an Azure AD application using the certificate with the following settings:

    • The cmdlet will use the certificate that is located at the C:\certificate\cert.pfx file path.
    • The cmdlet will assign the Application05 name to the application.

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

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

    $app = New-VBOOffice365ApplicationOnlyConnectionSettings -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword -NewApplicationName "Application05"

    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 following settings:
    • Specify the ApplicationCertificatePath parameter value.
    • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.
    • Specify the NewApplicationName parameter value.

    Related Commands

    Read-Host

    I want to report a typo

    There is a misspelling right here:

     

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