Get-VBREntraIDTenantBackup

Short Description

Returns backups of Microsoft Entra ID tenants.

Applies to

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

Syntax

This cmdlet provides cmdlet sets that allow you to:

  • Get all backups of Entra ID tenants.

Get-VBREntraIDTenantBackup [<CommonParameters>]

  • Get backups by their IDs.

Get-VBREntraIDTenantBackup -Id <Guid[]> [<CommonParameters>]

  • Get backups by job names.

Get-VBREntraIDTenantBackup -Name <String[]> [<CommonParameters>]

Detailed Description

This cmdlet returns backups of Microsoft Entra ID tenants.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Id

Specifies an array of tenant backup IDs.

Guid[]

True

Named

True (ByPropertyName)

Name

Specifies an array of job names whose backups you want to get.

String[]

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 array of VBREntraIDTenantBackup objects that contain properties of backups.

Examples

Get-VBREntraIDTenantBackupExample 1. Get All Backups

This example shows how to get all backups.

$tenantBackups = Get-VBREntraIDTenantBackup

Get-VBREntraIDTenantBackupExample 2. Get Backup by Job Name

This example shows how to get a tenant backup using the name of the backup job that created this backup.

$tenantBackup = Get-VBREntraIDTenantBackup -Name "Tenant Backup"

Page updated 11/19/2024

Page content applies to build 12.3.0.310