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

Get-VBRCloudTenant

Short Description

Returns cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

This cmdlet provides 4 parameter sets.

  • For looking for all cloud tenants:

Get-VBRCloudTenant  [<CommonParameters>]

  • For looking for cloud tenant by ID:

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

  • For looking for cloud tenants by name:

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

  • For looking for cloud tenants by a repository they use:

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

Detailed Description

This cmdlet returns cloud tenant accounts.

You can get the list of all existing tenant accounts, search for instances directly by name or ID or get loud tenants accounts using a particular backup repository. Use an appropriate scenario for each case.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies the array of tenant IDs you want to get.

Accepts GUID or string type.

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Name

Specifies the array of the tenants names you want to get or search conditions.

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Repository

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

Accepts CBackupRepository type.

You can specify simple or scale-out backup repositories.

You cannot specify cloud repositories.

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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

VBRCloudTenant[]

Example 1

This command looks for all cloud tenants.

PS C:\PS> Get-VBRCloudTenant

Example 2

This command looks for a cloud tenant by name.

PS C:\PS> Get-VBRCloudTenant -Name "ABC Company"

Example 3

This command looks for the cloud tenants by backup repository.

Run Get-VBRBackupRepository to get the repository and pipe the result to Get-VBRCloudTenant.

PS C:\PS> Get-VBRBackupRepository -Name "Backups Vol2" | Get-VBRCloudTenant

Related Commands

Get-VBRBackupRepository

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