New-VBREntraIDTenantItemExportMapping
Short Description
Defines an object with a restore point that you want to use when exporting Microsoft Entra ID item data.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
|
New-VBREntraIDTenantItemExportMapping -Item <VBREntraIDTenantItem> -RestorePoint <VBREntraIDTenantRestorePoint> [<CommonParameters>] |
Detailed Description
This cmdlet defines an object that specifies a restore point for Microsoft Entra ID item data export performed by running the Export-VBREntraIDTenantItemToJson cmdlet.
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept |
|---|---|---|---|---|---|
|
Item |
Specifies the backed-up tenant item whose data you want to export. |
Accepts the VBREntraIDTenantItem object. To get this object, run the Get-VBREntraIDTenantItem cmdlet. |
True |
Named |
False |
|
RestorePoint |
Specifies a restore point from which you want to export the item data. |
Accepts the VBREntraIDTenantRestorePoint object. To get this object, run the Get-VBREntraIDTenantRestorePoint cmdlet. |
True |
Named |
False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBREntraIDTenantItemExportMapping object that defines an object with a restore point that you want to use when exporting Microsoft Entra ID item data.
Examples
Defining Restore Point for Multiple Items
This example shows how to specify a restore point for 2 users whose data you plan to export.
|
$backup = Get-VBREntraIDTenantBackup -Name "Tenant-backup-1" $rp = Get-VBREntraIDTenantRestorePoint -Backup $backup -Id "61448046-067f-4908-88ad-31e785477fc6" $items = Get-VBREntraIDTenantItem -Backup $backup -Type User -Name "Admin-12","Admin-13" $mapping = New-VBREntraIDTenantItemExportMapping -Item $items[2] -RestorePoint $rp |
Perform the following steps:
- Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBREntraIDTenantRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Id parameter value. Save the result to the $rp variable.
- Run the Get-VBREntraIDTenantItem cmdlet. Set the $backup variable as the Backup parameter value. Specify the Type and Name parameter values. Save the result to the $items variable.
- Run the New-VBREntraIDTenantItemExportMapping cmdlet. Set the $items variable as the Item parameter value, and the $rp variable as the RestorePoint parameter value. Save the result to the $mapping variable.
Related Commands