Get-VBREntraIDTenantItem

Short Description

Returns Microsoft Entra ID items that a backup contains.

Applies to

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

Syntax

Get-VBREntraIDTenantItem -Backup <VBREntraIDTenantBackup> -Type <VBREntraIDTenantItemType> [-Name <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns Entra ID items that a backup contains.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies the backup from which you want to get Entra ID items.	Accepts the VBREntraIDTenantBackup object. To get this object, run the Get-VBREntraIDTenantBackup cmdlet.	True	Named	False
Type	Specifies the type of items that you want to return.	VBREntraIDTenantItemType	True	Named	False
Name	Specifies an array of item display names. The cmdlet will return items with these display names. Note: This parameter accepts wildcard characters.	String[]	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Backup

Specifies the backup from which you want to get Entra ID items.

Accepts the VBREntraIDTenantBackup object. To get this object, run the Get-VBREntraIDTenantBackup cmdlet.

True

Named

False

Type

Specifies the type of items that you want to return.

VBREntraIDTenantItemType

True

Named

False

Name

Specifies an array of item display names. The cmdlet will return items with these display names.

Note: This parameter accepts wildcard characters.

String[]

False

Named

False

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

Output Object

The cmdlet returns the array of VBREntraIDTenantItem objects that define settings of Entra ID items.

Examples

Get-VBREntraIDTenantItem Example 1. Getting Groups by Name

This example shows how to get backed-up groups whose displayed name start with "grp".

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

$groups = Get-VBREntraIDTenantItem -Backup $backup -Type Group -Name "grp*"

Perform the following steps:

Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBREntraIDTenantItem cmdlet. Specify the following settings:

Set the $backup variable as the Backup parameter value.
Specify the Type and Name parameter values.
Save the result to the $groups variable.

Get-VBREntraIDTenantItem Example 2. Getting All Administrative Units

This example shows how to get backed-up administrative units.

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

$units = Get-VBREntraIDTenantItem -Backup $backup -Type AdminUnit

Perform the following steps:

Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBREntraIDTenantItem cmdlet. Specify the following settings:

Set the $backup variable as the Backup parameter value.
Specify the Type parameter value.
Save the result to the $units variable.

Related Commands

Get-VBREntraIDTenantBackup