Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Remove-VBRCloudSubTenant

Short Description

Removes cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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
  • vCD Cloud 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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

SubTenant

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

Accepts the IVBRCloudSubTenant type.

True

Named

True (ByValue,
ByProperty
Name)

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 user is sure that they want to continue.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

None

Example

This example shows how to remove a cloud subtenant.

  1. Run Get-VBRCloudSubTenant to get the subtenant. Save the result to the $subtenant variable.
  2. Run Remove-VBRCloudSubTenant with the $subtenant variable.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

Remove-VBRCloudSubTenant -SubTenant $subtenant

Related Commands

Get-VBRCloudSubTenant

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation