Disable-VBRCloudSubTenant

In this article

    Short Description

    Disables cloud subtenant accounts.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

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

    Detailed Description

    This cmdlet disables a cloud subtenant account. When you disable a subtenant account, the subtenant cannot use their account resources. You can disable cloud subtenant accounts of the following types:

    • Simple cloud subtenant accounts
    • vCD Cloud subtenant accounts

    Run Enable-VBRCloudSubTenant to enable a disabled account.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    SubTenant

    Specifies the array of cloud subtenants that you want to disable. 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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    None

    Example

    This example shows how to disable a cloud subtenant.

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

    $subtenant = Get-VBRCloudSubTenant -Name "Alpha"

    Disable-VBRCloudSubTenant -SubTenant $subtenant

    Related Commands

    Get-VBRCloudSubTenant