Disable-VBRCloudSubUser

Short Description

Disables cloud subuser accounts.

Platform: VMware, Hyper-V

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

Syntax

Disable-VBRCloudSubUser -SubUser <IVBRCloudSubUser[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet disables a cloud subuser account. When you disable a subuser account, the subuser cannot use their account resources.

You can disable the cloud subtenant accounts of the following types:

Run the Enable-VBRCloudSubUser cmdlet to enable a disabled account.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
SubUser	Specifies the array of cloud subusers you want to disable. The subusers can have different parents. Accepts the `IVBRCloudSubUser[]` object. To get this object, run the `Get-VBRCloudSubUser` cmdlet.	`IVBRCloudSubUser[]`	True	Named	True (ByPropertyName, ByValue)
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
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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Disabling Cloud Subuser

This example shows how to disable a cloud subuser.

$subuser = Get-VBRCloudSubUser -Name "Subuser 1"

Disable-VBRCloudSubUser -SubUser $subuser

Perform the following steps:

Run the Get-VBRCloudSubUser cmdlet. Specify the Name parameter value. Save the result to the $subuser variable.
Run the Disable-VBRCloudSubUser cmdlet. Set the $subuser variable as the SubUser parameter value.