Win32_VirtualDesktopSession class

Article
12/11/2020

Manages a virtual desktop session.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("Win32_RDManagement_Prov"), AMENDMENT]
class Win32_VirtualDesktopSession
{
  string VMHostName;
  uint32 SessionId;
  string VMName;
  uint32 ConnectState;
  string UserName;
  string DomainName;
  string CollectionId;
  string ClientMachineName;
};

Members

The Win32_VirtualDesktopSession class has these types of members:

Methods
Properties

Methods

The Win32_VirtualDesktopSession class has these methods.

Method	Description
Disconnect	Disconnects the virtual desktop session.
Logoff	Logs off the user from the virtual desktop session.
SendMessage	Send a message to the user through the virtual desktop session.

Properties

The Win32_VirtualDesktopSession class has these properties.

ClientMachineName

Data type: string
Access type: Read-only

Gets the name of the client machine that is connected to the session.

CollectionId

Data type: string
Access type: Read-only

Gets the name of the virtual desktop collection that hosts the virtual machine.

ConnectState

Data type: uint32
Access type: Read-only

Gets the state of the connection to the session.

DomainName

Data type: string
Access type: Read-only

Gets the domain name of the user.

SessionId

Data type: uint32
Access type: Read-only
Qualifiers: key

Gets the ID of the virtual desktop session.

UserName

Data type: string
Access type: Read-only

Gets the name of the user account that is assigned to the session.

VMHostName

Data type: string
Access type: Read-only
Qualifiers: key

Gets the name of the Remote Desktop virtualization host server that hosts the virtual machine.

VMName

Data type: string
Access type: Read-only

Gets the name of the virtual machine that is assigned to the session.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\cimv2\rdms
MOF	RDManagement.mof
DLL	RDMS.dll