This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRCloudTenant

Short Description

Returns cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Requires a cloud provider license.

Syntax

This cmdlet provides the following parameter sets:

To look for all cloud tenant accounts

Get-VBRCloudTenant [<CommonParameters>]

To look for cloud tenant accounts by the tenant account ID

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

To look for cloud tenant accounts by the tenant account name

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

To look for cloud tenant accounts by a repository they use

Get-VBRCloudTenant [-Repository <CBackupRepository[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns cloud tenant accounts of the following types:

Simple cloud tenant accounts
vCD cloud tenant accounts

Important!

The cmdlet gets only information on a number of licensed objects. To get information on backups stored in quota (non-licensed objects), see the Tenant Machine Count section in Veeam Cloud Connect Guide.

Note

The cmdlet returns information on a number of processed workloads that consume instances from the license scope. Instances are not consumed if a provider obtains a rental license and workloads have been processed for the first time during the current month. These workloads are counted separately and the cmdlet will display them under the following tenant settings:

NewVMBackupCount
NewWorkstationBackupCount
NewServerBackupCount
NewReplicaCount

Workloads that start to consume instances on the first day of the following month are displayed under the following tenant settings:

VMCount
WorkstationCount
ServerCount
ReplicaCount

If a tenant obtains a rental license, these workloads do not consume instances from the provider license scope and are displayed under the following tenant settings:

RentalVMBackupCount
RentalWorkstationBackupCount
RentalServerBackupCount
RentalReplicaCount

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Id	Specifies an array of cloud tenant IDs you want to get. Accepts GUID or the string type.	False	Named	True (ByValue, ByProperty Name)	False
Name	Specifies an array of cloud tenant names. The cmdlet will return details on tenants with specified names.	False	Named	True (ByValue, ByProperty Name)	False
Repository	Specifies an array of backup repositories. The cmdlet will return the tenants that use these repositories. Accepts the CBackupRepository type. You can specify simple or scale-out backup repositories. You cannot specify cloud repositories.	False	Named	True (ByValue, ByProperty Name)	False

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Specifies an array of cloud tenant IDs you want to get.

Accepts GUID or the string type.

False

Named

True (ByValue,
ByProperty
Name)

False

Name

Specifies an array of cloud tenant names. The cmdlet will return details on tenants with specified names.

False

Named

True (ByValue,
ByProperty
Name)

False

Repository

Specifies an array of backup repositories. The cmdlet will return the tenants that use these repositories.

Accepts the CBackupRepository type.

You can specify simple or scale-out backup repositories.

You cannot specify cloud repositories.

False

Named

True (ByValue,
ByProperty
Name)

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

IVBRCloudTenant

VBRvCDCloudTenant

VBRaDCloudTenant

Example 1

This example shows how to look for all cloud tenants.

Get-VBRCloudTenant

Example 2

This example shows how to look for a cloud tenant by the tenant account name.

Get-VBRCloudTenant -Name "ABC Company"

Example 3

This example shows how to look for a cloud tenants by the tenant account backup repository.

Run Get-VBRBackupRepository to get the necessary repository. Save the result to the $repository variable.
Run Get-VBRCloudTenant with the $repository variable.

$repository = Get-VBRBackupRepository -Name "Backups Vol2"

Get-VBRCloudTenant -Repository $repository

Related Commands

Get-VBRBackupRepository