Request-VBREntraIDLogin

Short Description

Requests login to Microsoft Entra ID using an account associated with the tenant whose data you are restoring.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Request-VBREntraIDLogin -Session <VBREntraIDTenantRestoreSession> [<CommonParameters>]

Detailed Description

This cmdlet requests login to Entra ID using an account associated with the tenant whose data you are restoring. The login is required if the application used for restore does not have enough permissions of the application type. The permissions must be the same as for using an existing application. For more information, see the Permissions section in the User Guide for Microsoft Entra ID. By default, the application used while adding a tenant is also used for restore.

The cmdlet will provide you the verification code. Paste this code to the https://microsoft.com/devicelogin page. Then specify a Microsoft Entra user account that is associated with the tenant selected for restore. The account must have the same permissions as for creating a new application. The permissions are listed in the Permissions section in the User Guide for Microsoft Entra ID.

Use this cmdlet right after the Start-VBREntraIDTenantRestore cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies a restore session for which you want to request login to Microsoft Entra ID. Accepts the `VBREntraIDTenantRestoreSession` object. To get this object, run the `Get-VBREntraIDTenantRestoreSession` cmdlet.	`VBREntraIDTenantRestoreSession`	True	Named	False

<CommonParameters>

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

Output Object

Guid.

Examples

Requesting Login to Entra ID

This example shows how to request login to Entra ID.

$backup = Get-VBREntraIDTenantBackup -Name "Tenant backup"

$tenantRestoreSession = Start-VBREntraIDTenantRestore -Backup $backup

...

$requestId = Request-VBREntraIDLogin -Session $tenantRestoreSession

Perform the following steps:

Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Start-VBREntraIDTenantRestore cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $tenantRestoreSession variable.
Run the Request-VBREntraIDLogin cmdlet. Set the $tenantRestoreSession variable as the Session parameter value. Save the result to the $requestId variable.