Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBRCloudSubUser

Short Description

Returns cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 4 parameter sets.

  • For looking for all cloud subusers:

Get-VBRCloudSubUser [<CommonParameters>]

  • For looking for cloud subusers by ID:

Get-VBRCloudSubUser [-Id <guid[]>] [<CommonParameters>]

  • For looking for cloud subusers by name:

Get-VBRCloudSubUser [-Name <string[]>] [<CommonParameters>]

  • For looking for cloud subusers by a cloud service provider:

Get-VBRCloudSubUser [-CloudProvider <VBRCloudProvider[]>] [<CommonParameters>]

Detailed Description

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

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies the subuser ID. The cmdlet will return subusers with these IDs.  

Accepts GUID or string type.

False

Named

True (ByValue,
ByProperty
Name)

False

Name

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

False

Named

True (ByValue,
ByProperty
Name)

True

CloudProvider

Specifies the cloud provider. The cmdlet will return subusers associated with this cloud provider.

Accepts VBRCloudProvider type.

False

Named

True (ByValue,
ByProperty
Name)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRCloudSubUser

Example 1

This command returns all cloud subusers.

PS C:\PS> Get-VBRCloudSubUser

Example 2

This command looks for a subuser by name.

PS C:\PS> Get-VBRCloudSubUser -Name "Subuser 1"

Example 3

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

  1. Run Get-VBRCloudProvider to get a service provider. Save the result to the $cloudprovider variable.
  2. Run Get-VBRSubUser. Use the $cloudprovider variable.

PS C:\PS> $CloudProvider = Get-VBRCloudProvider

PS C:\PS> Get-VBRCloudSubUser -CloudProvider $cloudprovider

Related Commands

Get-VBRCloudProvider

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation