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

Get-VBRCloudSubTenant

Short Description

Returns cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets:

  • To look for all cloud subtenant accounts

Get-VBRCloudSubTenant [<CommonParameters>]

  • To look for cloud subtenants by ID

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

  • To look for cloud subtenants by name

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

  • To look for cloud subtenants by tenant

Get-VBRCloudSubTenant [-Tenant <IVBRCloudTenant[]>] [<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

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

IVBRCloudSubTenant

VBRvCDCloudSubTenant

Example 1

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

PS C:\PS> 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.

PS C:\PS> $Alpha = Get-VBRCloudTenant -Name "Alpha"

PS C:\PS> Get-VBRCloudSubTenant -Tenant $Alpha

Related Commands

Get-VBRCloudTenant

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation