Disable-VBRCloudTenant
Short Description
Disables cloud tenant accounts.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Requires a cloud provider license.
Syntax
Detailed Description
This cmdlet disables a cloud tenant account. When you disable a tenant account, the tenant cannot use their account resources. You can disable the cloud tenant accounts of the following types:
- Simple cloud tenant accounts
- Cloud Director tenant accounts
Run the Enable-VBRCloudTenant cmdlet to enable a disabled account.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
CloudTenant | Specifies the array of cloud tenant accounts you want to disable. | Accepts the VBRCloudTenant[] object. To get this object, run the Get-VBRCloudTenant cmdlet. | True | Named | True (ByValue, |
WhatIf | Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. | SwitchParameter | False | Named | False |
Confirm | Defines that the cmdlet will display a prompt that asks if you want to continue running the command. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
Examples
Example 1. Disabling Cloud Tenant Account
Example 2. Disabling Several Cloud Tenant Accounts
Related Commands
