New-VBRCloudSubUserResource

In this article

    Short Description

    Creates quotas of cloud subuser resources.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides 2 parameter sets.

    • For creating a quota with limited disk space:

    New-VBRCloudSubUserResource -CloudRepository <CCloudRepository> -RepositoryFriendlyName <string> -Quota <int> [<CommonParameters>]

    • For creating a quota with unlimited disk space:

    New-VBRCloudSubUserResource -CloudRepository <CCloudRepository> -RepositoryFriendlyName <string> -Unlimited [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new VBRCloudSubUserResource object. This object contains a quota of the tenant backup resources.

    The subtenant quota is a part of subuser account. To assign the quota to a subuser, run Add-VBRCloudSubUser and use the created VBRCloudSubUserResource object.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudRepository

    Specifies the backup resources of the cloud tenant. The disk space available under the cloud user account will be used as parent resources for creating the subuser quota.

    Use the Quota or the Unlimited parameter to indicate the amount of disk space you want to give to a subuser.

    Accepts CCloudRepository, GUID or string type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    RepositoryFriendlyName

    Specifies the name you want to give to the subuser quota.

    This name will be displayed in the list of backup repositories at the subuser side.

    True

    Named

    True (ByProperty
    Name)

    False

    Quota

    Specifies the amount of space you want to give to the subuser on the selected backup repository.

    Permitted value: 1 to 2097151  (GB).

    True

    Named

    True (ByProperty
    Name)

    False

    Unlimited

    Indicates that the quota of resources has unlimited disk space.

    With unlimited quota, the subuser will be able to use all parent cloud repository.

    True

    Named

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

    VBRCloudSubUserResource

    Example 1

    This example shows how to create a quota of resources for a subuser with a limited disk space.

    1. Get the cloud repository. Run Get-VBRBackupRepository and sort the obtained repositories by type to get cloud repositories. Select the needed cloud repository from the obtained array. Save the result to the $cloudrepository variable.
    2. Run New-VBRCloudSubUserResource with the $cloudrepository variable.

    $cloudrepository = Get-VBRBackupRepository | Where {$_.Type -eq "Cloud"} | Select -First 1

    New-VBRCloudSubUserResource -CloudRepository $cloudrepository -RepositoryFriendlyName "Cloud Repository 1" -Quota 10

    Example 2

    This example shows how to create a quota of resources for a subuser with unlimited disk space.

    1. Get the cloud repository. Run Get-VBRBackupRepository and sort the obtained repositories by type to get cloud repositories. Select the needed cloud repository from the obtained array. Save the result to the $cloudrepository variable.
    2. Run New-VBRCloudSubUserResource with the $cloudrepository variable.

    $cloudrepository = Get-VBRBackupRepository | Where {$_.Type -eq "Cloud"} | Select -First 1

    New-VBRCloudSubUserResource -CloudRepository $cloudrepository -RepositoryFriendlyName "Cloud Repository 1" -Unlimited

    Related Commands

    Get-VBRBackupRepository

    I want to report a typo

    There is a misspelling right here:

     

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