Get-VBRCloudSubTenant

Short Description

Returns cloud subtenant accounts.

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRCloudSubTenant [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
Id

Get-VBRCloudSubTenant [-Id <Guid[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
Name

Get-VBRCloudSubTenant [-Name <String[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
Tenant

Get-VBRCloudSubTenant [-Tenant <IVBRCloudTenant[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]

Detailed Description

This cmdlet returns cloud subtenant accounts of the following types:

Tip

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies the array of subtenant IDs. The cmdlet will return the subtenants with these IDs. Accepts `Guid[]` or `String[]`.	`Guid[]`	False	Named	True (ByPropertyName, ByValue)
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.	`VBRCloudSubTenantMode`	False	Named	False
Name	Specifies the array of names for the subtenant account you want to get or search conditions.	`String[]`	False	Named	True (ByPropertyName, ByValue)
Tenant	Specifies the tenant. The cmdlet will return the subtenants associated with this tenant. Accepts the `IVBRCloudSubTenant[]` and `VBRvCDCloudTenant[]` objects. To get one of the objects, run the `Get-VBRCloudTenant` cmdlet.	`IVBRCloudTenant[]`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

IVBRCloudSubTenant

VBRvCDCloudSubTenant

Examples

Get-VBRCloudSubTenant Example 1. Getting Cloud Subtenant by Name

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

Get-VBRCloudSubTenant -Name "Alpha"

Get-VBRCloudSubTenant Example 2. Getting Cloud Subtenant by Tenant

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

$Alpha = Get-VBRCloudTenant -Name "Alpha"

Get-VBRCloudSubTenant -Tenant $Alpha

Perform the following steps:

Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $Alpha variable.
Run the Get-VBRCloudSubTenant cmdlet. Set the $Alpha variable as the Tenant parameter value.