Get-VBRCloudTenantBackup
Short Description
Returns non-encrypted backups of AD tenants and tenants managed by the Service Provider.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get non-encrypted backups by the backup name.
Get-VBRCloudTenantBackup [-Name <String[]>] [-Tenant <IVBRCloudTenant[]>] [<CommonParameters>] |
- Get non-encrypted backups by the backup ID.
Get-VBRCloudTenantBackup [-Id <guid[]>] [-Name <String[]>] [-Tenant <IVBRCloudTenant[]>] [<CommonParameters>] |
Detailed Description
Returns non-encrypted backups of AD tenants and tenants managed by the Service Provider.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
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. | False | Named | True (ByPropertyName, ByValue) |
Id | Specifies an array of the backup IDs. The cmdlet will return backups with these IDs. | Guid[] | False | Named | True (ByValue, ByPropertyName) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRCloudTenantBackup object that contains backups of AD tenants and tenants managed by the Service Provider.
Examples
Getting Non-Encrypted Backups for AD Tenant Accounts
This example shows how to get a list of non-encrypted backups of AD tenants and tenants managed by the Service Provider.
$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.
Related Commands