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

New-VBOOffice365ConnectionSettings

In this article

Short Description

Defines connection settings to access Microsoft Office 365 organizations.

Syntax

This cmdlet provides parameter sets that allow you to:

Define connection settings to access Microsoft Office 365 organizations using basic authentication.

New-VBOOffice365ConnectionSettings -Credential <pscredential> [-GrantRolesAndPermissions] [-VeeamAADApplicationUsed] [<CommonParameters>]

Define connection settings to access Microsoft Office 365 organizations using modern authentication with an application secret.

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

Define connection settings to access Microsoft Office 365 organizations using modern authentication with an application certificate.

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

Detailed Description

This cmdlet creates the VBOOffice365ConnectionSettings object. This object defines connection 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.

Run the Add-VBOOrganization cmdlet to add Microsoft organizations to Veeam Backup for Microsoft Office 365 infrastructure.

New-VBOOffice365ConnectionSettings Important!

This type of connection settings utilizes legacy authentication protocols.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
AppCredential	For the modern authentication type. Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft Office 365 organization.	PSCredential	True	Named	False	False
ApplicationCertificatePassword	For the modern authentication type. Specifies an application password. The cmdlet will use these credentials to connect to a Microsoft Office 365 organization.	SecureString	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.	String	True	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.	Guid	True	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.	SecureString	True	Named	False	False
Credential	Specifies credentials. The cmdlet will use these credentials to connect to a Microsoft Office 365 organization.	PSCredential	True	Named	False	False
GrantRolesAndPermissions	Defines that the cmdlet will grant required permissions and assign appropriate roles to the account.	SwitchParameter	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	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBOOffice365ConnectionSettings object that contains connection settings to access Microsoft Office 365 organizations.

Examples

New-VBOOffice365ConnectionSettings Example 1. Defining Connection Settings with Basic Authentication

This example shows how to define Microsoft Office 365 organization connection settings with the basic authentication:

$credentials = Get-Credential

New-VBOOffice365ConnectionSettings -Credential $credentials -GrantRolesAndPermissions

Perform the following steps:

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.
Run the New-VBOOffice365ConnectionSettings cmdlet. Set the $credentials variable as the Credential parameter value. Provide the GrantRolesAndPermissions parameter to create.

New-VBOOffice365ConnectionSettings Example 2. Defining Connection Settings with Modern Authentication Using Application Secret

This example shows how to define Microsoft Office 365 organization connection settings with a modern authentication using an application secret:

$Credentials = Get-Credential

$ApplicationSecret = ConvertTo-SecureString -String "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s=" -AsPlainText -Force

New-VBOOffice365ConnectionSettings -AppCredential $Credentials -ApplicationId "d052f06e-1cfa-42ff-9636-9da5e7aa1fd" -ApplicationSecret $ApplicationSecret -GrantRolesAndPermissions

Perform the following steps:

Run the Get-Credential cmldet 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.
Run the ConvertTo-SecureString cmdlet to convert the plain text to the secure string. Specify the String parameter value. Provide the AsPlainText parameter to turn the plain text to the secure string. Provide the Force parameter. Save the result to the $ApplicationSecret variable.
Run the New-VBOOffice365ConnectionSettings cmdlet. Specify the following settings:

Set the $Credentials variable as the AppCredential parameter value.
Specify the ApplicationId parameter value.
Set the $ApplicationSecret variable as ApplicationSecret parameter value.
Provide the GrantRolesAndPermissions parameter.

To set up a secure connection to a Microsoft organization, open the https://microsoft.com/devicelogin link in a browser and enter the code that you get in the PowerShell Console to authenticate to the Microsoft Office 365 server.

New-VBOOffice365ConnectionSettings Example 3. Defining Connection Settings with Modern Authentication Using Application Certificate

This example shows how to define Microsoft Office 365 organization connection settings with a modern authentication using an application certificate:

$Credentials = Get-Credential

$ApplicationCertificatePassword = ConvertTo-SecureString -String "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s=" -AsPlainText -Force

New-VBOOffice365ConnectionSettings -AppCredential $Credentials -ApplicationId "d052f06e-1cfa-42ff-9636-9da5e7aa1fd1" -ApplicationCertificatePath "C:\ApplicationCertificate.pfx" -ApplicationCertificatePassword $ApplicationCertificatePassword -GrantRolesAndPermissions

Perform the following steps:

Run the Get-Credential cmldet 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.
Run the ConvertTo-SecureString cmdlet to convert the plain text to the secure string. Specify the String parameter value. Provide the AsPlainText parameter to turn the plain text to the secure string. Provide the Force parameter. Save the result to the $ApplicationSecret variable.
Run the New-VBOOffice365ConnectionSettings cmdlet. Specify the following settings:

Set the $Credentials variable as the AppCredential parameter value.
Specify the ApplicationId parameter value.
Specify the ApplicationCertificatePath parameter value.
Set the $ApplicationCertificatePassword variable as the ApplicationCertificatePassword parameter value.
Provide the GrantRolesAndPermissions parameter.

To set up a secure connection to a Microsoft organization, open the https://microsoft.com/devicelogin link in a browser and enter the code that you get in the PowerShell Console to authenticate to the Microsoft Office 365 server.

Related Commands