Get-VBREntraIDTenant
Short Description
Returns Microsoft Entra ID tenants added to the Veeam Backup & Replication backup infrastructure.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides cmdlet sets that allow you to:
- Get all tenants added to the backup infrastructure.
Get-VBREntraIDTenant [<CommonParameters>] |
- Get tenants by their IDs in the Veeam Backup & Replication backup infrastructure.
Get-VBREntraIDTenant [-Id <Guid[]>] [<CommonParameters>] |
- Get tenants by their IDs in the Microsoft Entra ID infrastructure.
Get-VBREntraIDTenant [-AzureTenantId <String[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns Entra ID tenants added to the backup infrastructure.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
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) |
AzureTenantId | Specifies an array of Microsoft Entra tenant IDs. | String[] | False | 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 array of VBREntraIdTenant objects that contain settings of tenants.
Examples
Example 1. Getting All Tenants
This example shows how to get all tenants added to the backup infrastructure.
|
Example 2. Getting Tenant Using Entra ID
This example shows how to get a tenant using its tenant ID in Entra ID.
|