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

Remove-VBRCloudSubUser

Short Description

Removes cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Remove-VBRCloudSubUser -SubUser <VBRCloudSubUser[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected cloud subuser account from Veeam Backup & Replication.

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

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

SubUser

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

Accepts VBRCloudSubUser type.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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 subuser.

  1. Run Get-VBRCloudSubUser to get the subuser. Save the result to the $subuser variable.
  2. Run Remove-VBRCloudSubUser with the saved variable.

PS C:\PS> $subuser = Get-VBRCloudSubUser -Name "Subuser 1"

PS C:\PS> Remove-VBRCloudSubUser -SubUser $subuser

Related Commands

Get-VBRCloudSubUser

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation