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

Set-VBRCloudSubTenantResource

Short Description

Modifies quotas of cloud subtenant resources settings.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 3 parameter sets.

To modify repository friendly name:

Set-VBRCloudSubTenantResource -CloudSubTenantResource <VBRCloudSubTenantResource> [-RepositoryFriendlyName <string>] [<CommonParameters>]

To modify the disk space limits:

Set-VBRCloudSubTenantResource -CloudSubTenantResource <VBRCloudSubTenantResource> [-RepositoryFriendlyName <string>] [-Quota <int>] [<CommonParameters>]

To change the disk space quota to unlimited:

Set-VBRCloudSubTenantResource -CloudSubTenantResource <VBRCloudSubTenantResource> [-RepositoryFriendlyName <string>] [-Unlimited] [<CommonParameters>]

Detailed Description

This cmdlet modifies the VBRCloudSubTenantResource object. This object contains the quota of the tenant's backup resources. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Run Set-VBRCloudSubTenant to apply the changes.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
CloudSubTenantResource	Specifies the quota of the subtenant backup resources you want to modify. Accepts VBRCloudSubTenantResource 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 side.	False	Named	False	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).	False	Named	False	False
Unlimited	Indicates that the quota of resources has unlimited disk space.	False	Named	False	False

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 modify the repository friendly name for a cloud subtenant.

Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
Get the existing subtenant quota using the Resources property of the VBRCloudSubTenantResource object saved to the $subtenant variable. Save the result to the $subtenantresources variable.
Run Set-VBRCloudSubTenantResource. Use the $SubtenantResource variable.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

$subtenantResources = $subtenant.Resources[0]

Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresource -RepositoryFriendlyName "Cloud repository for Alpha"

Example 2

This example shows how to modify the quota for a cloud subtenant.

Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
Get the existing subtenant quota using the Resources property of the VBRCloudSubTenantResource object saved to the $subtenant variable. Save the result to the $subtenantresources variable.
Run Set-VBRCloudSubTenantResource. Use the $subtenantresources variable.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

$subtenantresources = $subtenant.Resources[0]

Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresources -Quota 30

Example 3

This example shows how to set unlimited disk space to a cloud subtenant.

Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
Get the existing subtenant quota using the Resources property of the VBRCloudSubTenantResource object saved to the $subtenant variable. Save the result to the $subtenantresources variable.
Run Set-VBRCloudSubTenantResource. Use the $subtenantresources variable.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

$subtenantresources = $subtenant.Resources[0]

Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresources -Unlimited

Related Commands

Get-VBRCloudSubTenant