Remove-VBRCloudTenant - Veeam Backup PowerShell Reference

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
CloudTenant	Specifies the array of tenant accounts you want to remove.	Accepts the VBRCloudTenant[] object. To get this object, run the Get-VBRCloudTenant cmdlet.	True	Named	True (ByValue, ByProperty Name)
IncludeBackups	Defines that the cmdlet will remove all tenant backups.	SwitchParameter	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

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

$cloudtenants = Get-VBRCloudTenant

Remove-VBRCloudTenant -CloudTenant $cloudtenants

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Save the result to the $cloudtenants variable.
Run the Remove-VBRCloudTenant cmdlet. Set the $cloudtenants variable as the CloudTenant parameter value.

This example shows how to remove a Cloud Director tenant account.

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

Remove-VBRCloudTenant -CloudTenant $vCDtenant

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $vCDtenant variable.
Run the Remove-VBRCloudTenant cmdlet. Set the $vCDtenant variable as the CloudTenant parameter value.

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

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

$tenant = Get-VBRCloudTenant -Repository $repository

Remove-VBRCloudTenant -CloudTenant $tenant

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBRCloudTenant cmdlet. Set the $repository variable as the Repository parameter value. Save the result to the $tenant variable.
Run the Remove-VBRCloudTenant cmdlet. Set the $tenant variable as the CloudTenant parameter value.