Short Description
Disables cloud subtenant accounts.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRCloudSubTenant -SubTenant <VBRCloudSubTenant[]> [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet disables a cloud subtenant account. When you disable a subtenant account, the subtenant cannot use their account recourses. Run Enable-VBRCloudSubTenant to enable a disabled account.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
SubTenant | Specifies the array of cloud subtenants you want to disable. The subtenants can have different parents. Accepts VBRCloudSubTenant type. | True | Named | True (ByValue, | 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 disable a cloud subtenant.
- Run Get-VBRCloudSubTenant to get the subtenant. Save the result to the $subtenant variable.
- Run Disable-VBRCloudSubTenant with the saved variable.
PS C:\PS> $subtenant = Get-VBRCloudSubTenant -Name "Alpha" PS C:\PS> Disable-VBRCloudSubTenant -SubTenant $subtenant |
Related Commands
