New-VBRCloudSubTenantResource

In this article

    Short Description

    Creates quotas of cloud subtenant 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-VBRCloudSubTenantResource -Parent <VBRCloudTenantResource> -RepositoryFriendlyName <string> -Quota <int> [<CommonParameters>]

    • For creating a quota with unlimited disk space:

    New-VBRCloudSubTenantResource -Parent <VBRCloudTenantResource> -RepositoryFriendlyName <string> -Unlimited [<CommonParameters>]

    Detailed Description

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

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Parent

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

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

    Accepts VBRCloudTenantResource type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    RepositoryFriendlyName

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

    This name will be displayed in the list of backup repositories at the subtenant’s side.

    True

    Named

    True (ByProperty
    Name)

    False

    Quota

    Specifies the amount of space you want to give to the subtenant 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 subtenant will be able to use all disk space allocated to the parent.

    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

    VBRCloudSubtenantResource

    Example 1

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

    1. Run Get-VBRCloudTenant to get the cloud tenant whose resources you want to use as parent. Save the result to the $parent variable.
    2. Get the parent resources using the Resources property of the VBRCloudTenantResource object saved to the $parent variable. Save the result to the $parentresources variable.
    3. Run New-VBRCloudSubtenantResource. Use the $parentresources variable. Save the result to the $subtenantquota variable for future use.

    $parent = Get-VBRCloudTenant -Name "ABC Company"

    $parentresources = $parent.Resources[0]

    $subtenantquota = New-VBRCloudSubtenantResource -Parent $parentresource -RepositoryFriendlyName "ABC Cloud Repository" -Quota 10

    Example 2

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

    1. Run Get-VBRCloudTenant to get the cloud tenant whose resources you want to use as parent. Save the result to the $parent variable.
    2. Get the parent resources using the Resources property of the VBRCloudTenantResource object saved to the $parent variable. Save the result to the $parentresources variable.
    3. Run New-VBRCloudSubtenantResource. Use the $parentresources variable. Save the result to the $subtenantquota variable for future use.

    $parent = Get-VBRCloudTenant -Name "ABC Company"

    $parentresource = $parent.Resources[0]

    $subtenantquota = New-VBRCloudSubtenantResource -Parent $parentresource -RepositoryFriendlyName "ABC Cloud Repository" -Unlimited

    Related Commands

    Get-VBRBackupRepository

    New-VBRCloudTenantResource