Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Disable-VBRCloudTenant

Short Description

Disables cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Disable-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet disables a cloud tenant account. Disabling a tenant account temporarily prevents the tenant from using their account recourses. Run Enable-VBRCloudTenant to enable a disabled account.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Cloud
Tenant

Specifies the array of tenant accounts you want to disable.

Accepts VBRCloudTenant type.

True

Named

True (ByValue,
ByProperty
Name)

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the tenant is sure that they want to continue.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

None

Example 1

This command disables two cloud tenant accounts represented by the '$CloudUser1' and '$CloudUser2' variables.

The cloud tenant accounts are obtained by Get-VBRCloudTenant and assigned to the variables beforehand.

PS C:\PS> Disable-VBRCloudTenant -CloudTenant $CloudUser1, $CloudUser2

Example 2

This command disables the ABC company cloud tenant account.

The cloud tenant account is obtained by running Get-VBRCloudTenant and piped down.

PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Disable-VBRCloudTenant

Related Commands

Get-VBRCloudTenant

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation