Help Center
Choose product document...
Veeam Backup & Replication 9.5
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 4 parameter sets.

  • For looking for all cloud subtenant accounts:

Get-VBRCloudSubTenant [<CommonParameters>]

  • For looking for cloud subtenants by ID:

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

  • For looking for cloud subtenants by name:

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

  • For looking for cloud subtenants by tenant:

Get-VBRCloudSubTenant [-Tenant <VBRCloudTenant[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns cloud subtenant accounts.

You can get the list of all existing subtenant accounts, search for instances directly by name, ID or cloud tenant. Use an appropriate parameter set for each case.

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 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 VBRCloudTenant 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

VBRCloudSubTenant

Example 1

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

PS C:\PS> Get-VBRCloudSubTenant -Name "Alpha"

Example 2

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

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