Remove-RdsTenant

Module:: Microsoft.RDInfra.RDPowershell Module

Removes a tenant.

Syntax

Default (Default)

Remove-RdsTenant
    [-Name] <String>
    [<CommonParameters>]

Description

The Remove-RdsTenant cmdlet removes a tenant in the current context. You must first remove all host pools associated with the tenant before running this command.

Examples

Example 1

PS C:\> Remove-RdsTenant -Name "contoso"

This command removes a tenant in the current context.

Parameters

-Name

The name of the tenant.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TenantName

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Share via