Export-VBREntraIDTenantItemToJson
Short Description
Exports Microsoft Entra ID tenant item properties and metadata in the JSON format.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
|
Export-VBREntraIDTenantItemToJson -ExportMapping <VBREntraIDTenantItemExportMapping[]> -Session <VBREntraIDTenantRestoreSession> [<CommonParameters>] |
Detailed Description
This cmdlet exports properties and metadata of Microsoft Entra ID items (users, groups, roles, administrative units, applications, conditional access policies, intune policies, contacts and devices) from a backup and saves the exported data in the JSON format.
To specify a restore point for data export, use the New-VBREntraIDTenantItemExportMapping cmdlet.
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept |
|---|---|---|---|---|---|
|
ExportMapping |
Specifies an object with a restore point that you want to use when exporting Microsoft Entra ID item data. |
Accepts an array of VBREntraIDTenantItemExportMapping objects. To get this object, run the New-VBREntraIDTenantItemExportMapping cmdlet. |
True |
Named |
False |
|
Session |
Specifies the session launched to export Microsoft Entra ID item data. |
Accepts the VBREntraIDTenantRestoreSession object. To get this object, run the Start-VBREntraIDTenantRestore 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 a JSON string.
|
Note |
|
All the data is exported as a single string. If you plan to export multiple items, consider running the cmdlet several times. |
Examples
Exporting Entra ID Tenant Item Data
This example shows how to export properties and metadata of the Admin-12 user backed-up by the Tenant-backup-1 job.
|
$backup = Get-VBREntraIDTenantBackup -Name "Tenant-backup-1" $rp = Get-VBREntraIDTenantRestorePoint -Backup $backup -Id "61448046-067f-4908-88ad-31e785477fc6" $item = Get-VBREntraIDTenantItem -Backup $backup -Type User -Name "Admin-12" $mapping = New-VBREntraIDTenantItemExportMapping -Item $item -RestorePoint $rp $session = Start-VBREntraIDTenantRestore -Backup $backup $json = Export-VBREntraIDTenantItemToJson -ExportMapping $mapping -Session $session |
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 $item variable.
- Run the New-VBREntraIDTenantItemExportMapping cmdlet. Set the $item variable as the Item parameter value, and the $rp variable as the RestorePoint parameter value. Save the result to the $mapping variable.
- Run the Start-VBREntraIDTenantRestore cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $session variable.
- Run the Export-VBREntraIDTenantItemToJson cmdlet and do the following:
- Set the $mapping variable as the ExportMapping parameter value.
- Set the $session variable as the Session parameter value.
- Save the result to the $json variable.
Related Commands