Get-VBRCloudTenantBackup

Short Description

Returns backups of AD tenants and tenants managed by the Service Provider.

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRCloudTenantBackup [-Name <String[]>] [-Tenant <IVBRCloudTenant[]>] [-All] [<CommonParameters>]
Id

Get-VBRCloudTenantBackup [-Id <Guid[]>] [-Name <String[]>] [-Tenant <IVBRCloudTenant[]>] [-All] [<CommonParameters>]

Detailed Description

Returns backups of AD tenants and tenants managed by the Service Provider.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
All	Defines that the cmdlet will return all types of backups: encrypted, non-encrypted, managed and not managed by the Service Provider.	`SwitchParameter`	False	Named	False
Id	Specifies an array of the backup IDs. The cmdlet will return backups with these IDs.	`Guid[]`	False	Named	True (ByPropertyName, ByValue)
Name	Specifies the array of the job names. The cmdlet will return backups produced with these jobs.	`String[]`	False	Named	True (ByPropertyName, ByValue)
Tenant	Specifies an array of tenant accounts for which you want to get backup files. Accepts the `IVBRCloudTenant[]` object. To create this object, run the `Get-VBRCloudTenant` cmdlet.	`IVBRCloudTenant[]`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

Examples

Get-VBRCloudTenantBackup Example 1. Getting Non-Encrypted Backups for AD Tenant Accounts

This example shows how to get a list of non-encrypted backups of the ABC Company tenant.

$tenant = Get-VBRCloudTenant -Name "ABC Company"

$backupfiles = Get-VBRCloudTenantBackup -Tenant $tenant

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
Run the Get-VBRCloudTenantBackup cmdlet. Set the $tenant variable as the Tenant parameter value. Save the result to the $backupfiles variable.

Get-VBRCloudTenantBackup Example 2. Getting All Backups for Tenant Account

This example shows how to get a list of all encrypted and non-encrypted backups of the ABC Company tenant.

$tenant = Get-VBRCloudTenant -Name "ABC Company"

$allbackups = Get-VBRCloudTenantBackup -All -Tenant $tenant

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
Run the Get-VBRCloudTenantBackup cmdlet. Provide the All parameter. Set the $tenant variable as the Tenant parameter value. Save the result to the $allbackups variable.