Remove-VBRCloudSubTenant

Short Description

Removes cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRCloudSubTenant -SubTenant <IVBRCloudSubTenant[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected cloud subtenant account from Veeam Backup & Replication. You can remove subtenant accounts of the following types:

Simple cloud subtenant accounts
Cloud Director subtenant accounts

When you remove a subtenant, all backups stored on the cloud repository on this subtenant are removed permanently. The service provider cannot undo this operation. The resources associated with this subtenant account becomes available for use by the service provider.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
SubTenant	Specifies the array of cloud subtenants that you want to remove. The subtenants can have different parents.	Accepts the IVBRCloudSubTenant[] object. To get this object, run the Get-VBRCloudSubTenant cmdlet.	True	Named	True (ByValue, ByProperty Name)
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

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

SubTenant

Specifies the array of cloud subtenants that you want to remove. The subtenants can have different parents.

Accepts the IVBRCloudSubTenant[] object. To get this object, run the Get-VBRCloudSubTenant cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

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 cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Removing Cloud Subtenant

This example shows how to remove a cloud subtenant.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

Remove-VBRCloudSubTenant -SubTenant $subtenant

Perform the following steps:

Run the Get-VBRCloudSubTenant cmdlet. Specify the Name parameter value. Save the result to the $subtenant variable.
Run the Remove-VBRCloudSubTenant cmdlet. Set the $subtenant variable as the SubTenant parameter value.

Related Commands

Get-VBRCloudSubTenant