Get-VBRCloudTapeBackupTenant

In this article

    Short Description

    Returns tenants backups.

    Applies to

    Product Edition: Enterprise

    Requires Cloud Connect license

    Syntax

    This cmdlet provides the following parameter sets:

    • For getting tenants backups by the tenant name

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

    • To get tenant backups by the tenant ID

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

    Detailed Description

    This cmdlet returns the array of backups of tenants.

    Get-VBRCloudTapeBackupTenant Important!

    You can run this cmdlet from the service provider side only.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies an array of tenant names. The cmdlet will return backups of tenants with these names.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Id

    Specifies an array of tenant IDs. The cmdlet will return backups of tenants with the specified IDs.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

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

    Return Type

    Example 1

    This command gets backups of all tenants.

    Get-VBRCloudTapeBackupTenant

    Example 2

    This command gets backups of a tenant with a specific tenant ID.

    Get-VBRCloudTapeBackupTenant -ID "0fccf7c9-1f90-49de-8bec-53a0697e04ab"

    Example 3

    This command gets a backup of a tenant by the tenant name.

    Get-VBRCloudTapeBackupTenant -Name "New tenant"

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.