Win32_RDMSVirtualDesktopCollection class
Creates and manages a virtual desktop collection.
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_RDMSVirtualDesktopCollection
{
string Alias;
uint32 Type;
boolean IsManaged;
string Name;
string CollectionDescription;
string SecurityDescriptor;
string VmFarmSettings;
string UserVHDSetting;
uint8 IconContents[];
boolean ShowInPortal;
boolean IsHA;
boolean IsUserAdmin;
boolean RollbackEnabled;
};
Members
The Win32_RDMSVirtualDesktopCollection class has these types of members:
Methods
The Win32_RDMSVirtualDesktopCollection class has these methods.
| Method | Description |
|---|---|
| AddVirtualDesktop | Adds a virtual desktop to a virtual desktop collection. |
| CancelPatch | Cancels a software update provisioning job for the virtual machines in a virtual desktop collection. |
| GetInt32Property | Retrieves an integer property value from a virtual desktop collection. |
| GetPatchProperties | Retrieves the properties of a software update provisioning job for the virtual machines in a virtual desktop collection. |
| GetStringProperty | Retrieves a string property value from a virtual desktop collection. |
| ProvisioningEnumerateJobs | Enumerates virtual desktop provisioning jobs for this service. |
| ProvisioningJobCancel | Cancels a virtual desktop provisioning job. |
| ProvisioningJobExecute | Runs a virtual desktop provisioning job. |
| ProvisioningJobGetReport | Gets a report about the status of a virtual desktop provisioning job. |
| ProvisioningPrepJob | Creates a virtual desktop provisioning job. |
| RemoveVirtualDesktop | Removes a virtual desktop from a virtual desktop collection. |
| SchedulePatch | Schedules a software update provisioning job that installs software updates on the virtual machines in a virtual desktop collection. |
| SetInt32Property | Updates an integer property value of a virtual desktop collection. |
| SetStringProperty | Updates a string property value of a virtual desktop collection. |
Properties
The Win32_RDMSVirtualDesktopCollection class has these properties.
-
Alias
-
-
Data type: string
-
Access type: Read/write
-
Qualifiers: key
Gets or sets the alias of the collection
-
-
CollectionDescription
-
-
Data type: string
-
Access type: Read/write
-
Qualifiers: optional
Gets or sets the description of the collection
-
-
IconContents
-
-
Data type: uint8 array
-
Access type: Read/write
-
Qualifiers: optional
Gets or sets an array of values that specify icons for the collection.
-
-
IsHA
-
-
Data type: boolean
-
Access type: Read/write
Gets or sets a values that indicates whether the collection contains highly available VMs. TRUE if the collection contains highly available VMs; otherwise, FALSE.
-
-
IsManaged
-
-
Data type: boolean
-
Access type: Read/write
Gets or sets a value that indicates whether the collection is managed. TRUE if the collection is managed; otherwise, FALSE.
-
-
IsUserAdmin
-
-
Data type: boolean
-
Access type: Read/write
Gets or sets a values that indicates whether a user is an administrator on a VM. TRUE if the user is an administrator on a VM; otherwise, FALSE.
-
-
Name
-
-
Data type: string
-
Access type: Read/write
Gets or sets the name of the collection.
-
-
RollbackEnabled
-
-
Data type: boolean
-
Access type: Read/write
Gets or sets a values that indicates whether a VM was rolled with a VM snapshot. TRUE if the VM was rolled with a VM snapshot; otherwise, FALSE.
-
-
SecurityDescriptor
-
-
Data type: string
-
Access type: Read/write
-
Qualifiers: optional
Gets or sets an SSDL formated security descriptor that controls access to the collection.
-
-
ShowInPortal
-
-
Data type: boolean
-
Access type: Read/write
Gets or sets a values that indicates whether the collection is displayed in Terminal Services Web Access (TS Web Access). TRUE to display the collection in TS Web Access; otherwise, FALSE.
-
-
Type
-
-
Data type: uint32
-
Access type: Read/write
Gets or sets a value that indicates the type of virtual machine sessions hosted by the collection.
This property contains one of the following values:
-
-
TempVM (1)
-
Temporary virtual machines.
-
ManualPersonalVM (2)
-
Manually created virtual machines.
-
AutoPersonalVM (3)
-
Auto-generated virtual machines.
UserVHDSetting
-
Data type: string
-
Access type: Read/write
-
Qualifiers: optional
Gets or sets the user data VHD setting for the collection.
VmFarmSettings
-
Data type: string
-
Access type: Read/write
-
Qualifiers: optional
Gets or sets he desktop settings for the virtual machines in the collection.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\cimv2\rdms |
| MOF |
|
| DLL |
|