Get-VBREntraIDTenant

Short Description

Returns Microsoft Entra ID tenants added to the backup infrastructure.

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBREntraIDTenant [<CommonParameters>]
Id

Get-VBREntraIDTenant [-Id <Guid[]>] [<CommonParameters>]
AzureTenantId

Get-VBREntraIDTenant [-AzureTenantId <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns Entra ID tenants added to the backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AzureTenantId	Specifies an array of Microsoft Entra tenant IDs.	`String[]`	False	Named	False
Id	Specifies an array of Veeam Backup & Replication tenant IDs. Note: These are IDs that Veeam Backup & Replication assigns to the tenants after they are added to the backup infrastructure.	`Guid[]`	False	Named	True (ByPropertyName)

<CommonParameters>

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

Output Object

The cmdlet returns the array of VBREntraIdTenant objects that contain settings of tenants.

Examples

Get-VBREntraIDTenant Example 1. Getting All Tenants

This example shows how to get all tenants added to the backup infrastructure.

$tenants = Get-VBREntraIdTenant

Get-VBREntraIDTenant Example 2. Getting Tenant Using Entra ID

This example shows how to get a tenant using its tenant ID in Entra ID.

$tenant = Get-VBREntraIdTenant -AzureTenantId "xxxx"