This is an archive version of the document. To get the most up-to-date information, see the current version.

Remove-VBRCloudTenant

Short Description

Removes cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

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

Requires a cloud provider license.

Syntax

Remove-VBRCloudTenant -CloudTenant <IVBRCloudTenant[]> [-IncludeBackups [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet removes cloud tenant accounts. You can remove the accounts of the following types:

Simple cloud tenant accounts
vCD Cloud tenant accounts

The tenant account is removed permanently from Veeam Backup & Replication. The service provider cannot undo this operation.

When you remove a cloud tenant account that was using WAN accelerators, the WAN accelerators' cache is cleared automatically.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
CloudTenant	Specifies the array of tenant accounts you want to remove. Accepts the VBRCloudTenant type.	True	Named	True (ByValue, ByProperty Name)	False
IncludeBackups	Defines that the cmdlet will remove all tenant backups.	False	Named	False	False
WhatIf	Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	False	Named	False	False
Confirm	Specifies whether the cmdlet displays a prompt that asks if the tenant is sure that they want to continue.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

None.

Example 1

This example shows how to remove all cloud tenant accounts registered in Veeam Backup & Replication.

Run Get-VBRCloudTenant to get the cloud tenant accounts. Save the result to the $cloudtenants variable.
Run Remove-VBRCloudTenant with the $cloudtenants variable.

$cloudtenants = Get-VBRCloudTenant

Remove-VBRCloudTenant -CloudTenant $cloudtenants

Example 2

This example shows how to remove a vCD cloud tenant account.

Run Get-VBRCloudTenant to get the cloud tenant account that you want to remove. Save the result to the $vCDtenant variable.
Run Remove-VBRCloudTenant with the $vCDtenant variable.

$vCDtenant = Get-VBRCloudTenant -Name "vCD Tenant"

Remove-VBRCloudTenant -CloudTenant $vCDtenant

Example 3

This example shows how to remove all cloud tenant accounts by specifying their backup repository.

Run Get-VBRBackupRepository to get the necessary repository. Save the result to the $repository variable.
Run Get-VBRCloudTenant with the $repository variable to get the cloud tenant accounts. Save the result to the $tenant variable.
Run Remove-VBRCloudTenant with the $tenant variable.

$repository = Get-VBRBackupRepository -Name "Backups Vol2"

$tenant = Get-VBRCloudTenant -Repository $repository

Remove-VBRCloudTenant -CloudTenant $tenant

Related Commands

Get-VBRCloudTenant

Get-VBRBackupRepository