Set-RdsContext

Module:: Microsoft.RDInfra.RDPowershell Module

Sets the tenant group context for subsequent Windows Virtual Desktop cmdlets.

Syntax

Default (Default)

Set-RdsContext
    [-TenantGroupName] <String>
    [<CommonParameters>]

Description

The Set-RdsContext cmdlet sets the tenant group context for subsequent RDS PowerShell cmdlets. This context is only valid for the duration of the PowerShell session or until another Set-RdsContext is run. If not specified after running Add-RdsAccount, “Default Tenant Group” will be used.

Examples

Example 1: Set the Windows Virtual Desktop context

PS C:\> Set-RdsContext -TenantGroupName "contosoTenantGroup"

This command sets the context to use the specified tenant group.

Parameters

-TenantGroupName

The name of the tenant group.

Parameter properties

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

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