Get-VBRCloudSubTenant

In this article

    Short Description

    Returns cloud subtenant accounts.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides the following parameter sets:

    • To look for all cloud subtenant accounts

    Get-VBRCloudSubTenant [-Mode <VBRCloudSubTenantMode> {Common | AgentManagement}]  [<CommonParameters>]

    • To look for cloud subtenants by ID

    Get-VBRCloudSubTenant [-Id <guid[]>] [-Mode <VBRCloudSubTenantMode> {Common | AgentManagement}] [<CommonParameters>]

    • To look for cloud subtenants by name

    Get-VBRCloudSubTenant [-Name <string[]>] [-Mode <VBRCloudSubTenantMode> {Common | AgentManagement}] [<CommonParameters>]

    • To look for cloud subtenants by tenant

    Get-VBRCloudSubTenant [-Tenant <IVBRCloudTenant[]>] [-Mode <VBRCloudSubTenantMode> {Common | AgentManagement}] [<CommonParameters>]

    Detailed Description

    This cmdlet returns cloud subtenant accounts of the following types:

    • Simple cloud subtenant accounts.
    • vCD cloud subtenant accounts.

     

     

    Get-VBRCloudSubTenant Tip:

    You can get the cloud subtenant accounts from the specified cloud tenant. Run Get-VBRCloudTenant to get the cloud tenant.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

    Specifies the array of subtenant IDs. The cmdlet will return the subtenants with these IDs.

    Accepts GUID or the string type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Mode

    Specifies the cloud subtenant mode. You can select either of the following modes:

    • Common
    • AgentManagement

    The cmdlet will return subusers of the specified mode.

    False

    Named

    False

    False

    Name

    Specifies the array of names for the subtenant account you want to get or search conditions.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    True

    Tenant

    Specifies the tenant. The cmdlet will return the subtenants associated with this tenant.

    Accepts the IVBRCloudSubTenant and VBRvCDCloudTenant types.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    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

    IVBRCloudSubTenant

    VBRvCDCloudSubTenant

    Example 1

    This example shows how to get a simple cloud subtenant by name.

    Get-VBRCloudSubTenant -Name "Alpha"

    Example 2

    This example shows how to get a cloud subtenant by tenant.

    1. Run Get-VBRCloudTenant to get the cloud tenant. Save the result to the $Alpha variable.
    2. Run Get-VBRCloudSubTenant with the $Alpha variable.

    $Alpha = Get-VBRCloudTenant -Name "Alpha"

    Get-VBRCloudSubTenant -Tenant $Alpha

    Related Commands

    Get-VBRCloudTenant