---
title: "Get-VBRCloudSubTenant"
description: "This cmdlet returns cloud subtenant accounts of the following types: Simple cloud subtenant accounts. Cloud Director subtenant accounts. You can get the cloud subtenant accounts from the specified cloud tenant."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/get-vbrcloudsubtenant.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Cloud Connect > Veeam Cloud Connect Subtenants > Get-VBRCloudSubTenant"
dateModified: "2026-08-19"
---

# 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:

<ul class="syntax-sets">
  <li>
    <p><code>AllParameterSets (Default)</code></p>

```
Get-VBRCloudSubTenant [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Id</code></p>

```
Get-VBRCloudSubTenant [-Id <Guid[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Name</code></p>

```
Get-VBRCloudSubTenant [-Name <String[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Tenant</code></p>

```
Get-VBRCloudSubTenant [-Tenant <IVBRCloudTenant[]>] [-Mode <VBRCloudSubTenantMode>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet returns cloud subtenant accounts of the following types:

- Simple cloud subtenant accounts.
- Cloud Director subtenant accounts.

::: tip

You can get the cloud subtenant accounts from the specified cloud tenant. Run the [`Get-VBRCloudTenant`](get-vbrcloudtenant.md) cmdlet to get the cloud tenant.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Id</span></p>
        </td>
        <td>
          <p>Specifies the array of subtenant IDs. The cmdlet will return the subtenants with these IDs.</p><p>Accepts <code>Guid[]</code> or <code>String[]</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>Guid[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Mode</span></p>
        </td>
        <td>
          <p>Specifies the cloud subtenant mode. You can select either of the following modes:</p><ul><li><code>Common</code></li><li><code>AgentManagement</code></li></ul><p>The cmdlet will return subusers of the specified mode.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRCloudSubTenantMode</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies the array of names for the subtenant account you want to get or search conditions.</p>
        </td>
        <td style="width:10%;">
          <p><code>String[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Tenant</span></p>
        </td>
        <td>
          <p>Specifies the tenant. The cmdlet will return the subtenants associated with this tenant.</p><p>Accepts the <code>IVBRCloudSubTenant[]</code> and <a href="vbrvcdcloudtenant.md"><code>VBRvCDCloudTenant[]</code></a> objects. To get one of the objects, run the <a href="get-vbrcloudtenant.md"><code>Get-VBRCloudTenant</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IVBRCloudTenant[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
`IVBRCloudSubTenant`

`VBRvCDCloudSubTenant`

## Examples

::: example
### Example 1. Getting Cloud Subtenant by Name

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

```
Get-VBRCloudSubTenant -Name "Alpha"
```

:::

::: example
### 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:

1. Run the [`Get-VBRCloudTenant`](get-vbrcloudtenant.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$Alpha` variable.
2. Run the `Get-VBRCloudSubTenant` cmdlet. Set the `$Alpha` variable as the `Tenant` parameter value.

:::

## Related Commands

[`Get-VBRCloudTenant`](get-vbrcloudtenant.md)