---
title: "Get-VBRCloudSubUser"
description: "This cmdlet returns cloud subuser accounts of the following types: Simple cloud subtenant accounts Cloud Director subtenant accounts You can get the list of all existing subuser accounts, or narrow down the search results to name, ID or cloud..."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/get-vbrcloudsubuser.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Cloud Connect > Veeam Cloud Connect Subusers > Get-VBRCloudSubUser"
dateModified: "2026-08-19"
---

# Get-VBRCloudSubUser

## Short Description
Returns cloud subuser 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-VBRCloudSubUser [-Mode <VBRCloudSubUserMode>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Id</code></p>

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

```
Get-VBRCloudSubUser [-Name <String[]>] [-Mode <VBRCloudSubUserMode>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>CloudProvider</code></p>

```
Get-VBRCloudSubUser [-CloudProvider <VBRCloudProvider[]>] [-Mode <VBRCloudSubUserMode>] [<CommonParameters>]
```
  </li>
</ul>

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

- Simple cloud subtenant accounts
- Cloud Director subtenant accounts

You can get the list of all existing subuser accounts, or narrow down the search results to name, ID or cloud provider. Use an appropriate parameter set for each case.

## 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">CloudProvider</span></p>
        </td>
        <td>
          <p>Specifies a cloud provider. The cmdlet will return subusers associated with this cloud provider.</p><p>Accepts the <a href="vbrcloudprovider.md"><code>VBRCloudProvider[]</code></a> object. To get this object, run the <a href="get-vbrcloudprovider.md"><code>Get-VBRCloudProvider</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrcloudprovider.md"><code>VBRCloudProvider[]</code></a></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">Id</span></p>
        </td>
        <td>
          <p>Specifies an array of subuser ID. The cmdlet will return subusers with these IDs.</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>VBRCloudSubUserMode</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 an array of names for subuser accounts. The cmdlet will return subusers with names.</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>
    </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
`IVBRCloudSubUser`

## Examples

::: example
### Example 1. Getting All Cloud Subusers

This command returns all cloud subusers.

```
Get-VBRCloudSubUser
```

:::

::: example
### Example 2. Getting Cloud Subuser by Name

This command looks for a subuser by the subuser name.

```
Get-VBRCloudSubUser -Name "Subuser 1"
```

:::

::: example
### Example 3. Getting Cloud Subuser by Cloud Service Provider

This example shows how to get a subuser by a cloud service provider.

```
$cloudProvider = Get-VBRCloudProvider
Get-VBRCloudSubUser -CloudProvider $cloudprovider
```

Perform the following steps:

1. Run the [`Get-VBRCloudProvider`](get-vbrcloudprovider.md) cmdlet. Save the result to the `$cloudprovider` variable.
2. Run the `Get-VBRCloudSubUser` cmdlet. Set the `$cloudprovider` variable as the `CloudProvider` parameter value.

:::

## Related Commands

[`Get-VBRCloudProvider`](get-vbrcloudprovider.md)