New-VBOOffice365ApplicationOnlyConnectionSettings
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 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 VBOApplicationOnlyConnectionSettings 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 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 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 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 365 server you must provide a Microsoft 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.
|
This cmdlet is available only in Veeam Backup for Microsoft 365 version 4c or later. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
---|---|---|---|---|---|---|
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 | False |
OfficeOrganizationName | Specifies a name of Microsoft organization. The cmdlet will use this name to authenticate against the Microsoft 365 server. | String | True | Named | True | 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 | True | Named | True | 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 | 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 | 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 | False |
ConfigureApplication | Defines that the cmdlet will configure settings of an existing Azure AD application. | SwitchParameter | False | Named | False | False |
SharePointSaveAllWebParts | Defines that the cmdlet will add SharePoint Web Parts to Azure AD application settings. | SwitchParameter | 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.
Output Object
The cmdlet returns the VBOApplicationOnlyConnectionSettings object that defines Azure AD application settings.
Examples
Example 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 365 server.
Perform the following steps:
|
Example 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 365 server. The cmdlet will not configure Azure AD application settings.
Perform the following steps:
|
Example 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.
Perform the following steps:
|
Example 4. Defining Settings of Existing Azure AD Application
This example shows how to define settings of an existing Azure AD application.
Perform the following steps:
|
Example 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:
Perform the following steps:
|
Related Commands