Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
RASAdminEngine.Core.OutputModels
AD Integration Settings
⇒
ADIntegrationSettings
ISerializable
IComparable
Type | Name | Description
String | CertificateAuthority | Certificate authority
String | EnrollmentAgentUsername | Principal name in UPN format that will enroll certificates on behalf of
other users. | String | NLAUsername
Username of the network level authentication | UInt32 | SiteId
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|----| | | Get-RASADIntegrationSettings | | | Invoke-RASADIntegrationSettings |
RASAdminEngine.Core.OutputModels
RAS Admin
⇒
⇒
AdminAccount
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
String | Email | The user email address.
Boolean | Enabled | Whether this administrator is enabled or disabled in the farm.
Boolean | FullPermissions | Whether the "Full Permissions" option is enabled or disabled.
String | GroupName | Group name.
UInt32 | Id | String
Mobile | The user mobile phone number. | String
Name | Parallels RAS administrator user or group name. | AdminNotify
Notify | Admin Notification type. 0 = None, 1 = Email | PermissionType
Permissions | Specifies the type of permissions that are used. | DateTime
TimeCreate | Inherited from RASListObj | DateTime
TimeLastMod | Inherited from RASListObj | AdminType
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|------------------------------------------------------------------| | | Get-RASAdminAccount | | | New-RASAdminAccount |
RASAdminEngine.Core.OutputModels.Provider
Admin Credentials
⇒
AdminCredential
ISerializable
IComparable
Type | Name | Description
Boolean | Enabled | Whether credentials are enabled or not.
UInt32 | Priority | The priority
String | Username | Username
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
RAS Admin Session
⇒
AdminSession
ISerializable
IComparable
Type | Name | Description
String | ComputerName | Computer name of the session.
UInt32 | Id | String
Language | Language of the session | DateTime
State | State of session. | UInt32
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
AllowClientMode
Allow Mode
Values
Description
AllowAllClientsConnectToSystem
Allow All Clients Connect To System
AllowSelectedClientsConnectToSystem
Allow Selected Clients Connect To System
AllowSelectedClientsListPublishedItems
Allow Selected Clients List Published Items
RASAdminEngine.Core.OutputModels.HostPool
Action Settings
⇒
ActionSettings
ISerializable
IComparable
Type | Name | Description
UInt32 | PerformActionAfterSec | Perform action after (in seconds).
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.HostPool
Host Pool Agent Settings
⇒
AgentSettings
ISerializable
IComparable
Type | Name | Description
Boolean | AllowRemoteExec | Specifies if 'Allow 2XRemoteExec to send command to the client' option
Specifies the 'Allow Client URL/Mail Redirection'. | UInt32 | DisconnectActiveSessionAfter
Specifies the mode the drag and drop feature will operate. | Boolean | EnableDriveRedirectionCache
Specifies if the 'Enable Drive Redirection Cache' option is enabled or | disabled. | String
FileTransferLocation | Location where the File Transfer takes place, if and where it is | allowed.
Boolean | FileTransferLockLocation | Lock Location where the File Transfer takes place, if and where it is
Specifies if File Transfer option is allowed and if yes, which | directions are allowed. | UInt32
LogoffDisconnectedSessionAfter | Logoff disconnected session after (in seconds). 0 for 'Never'; 1 for | 'Immediate'.
UInt32 | SessionReadinessTimeout | Session readiness timeout (in seconds).
Boolean | SupportShellURLNamespaceObjects | Specifies if 'Support Shell URL Namespace Objects' option is enabled or
Type | Name | Description
GetType () | String | ToString ()
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
IP | IP of the session. |
LogonTime | Session Logon Time. |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
| PerformAction | Perform action on session change.
| SessionAction | Session action.
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|--------------------------------------------------------| | | | | | |
is enabled or disabled. | | AllowURLAndMailRedirection
Disconnect active session after (in seconds). 0 for 'Never'. | | DragAndDropMode
allowed. | | FileTransferMode
| ManageRDPTransportProtocol | Manage RDP transport protocol.
Int32 | CompareTo (Object obj) | Inherited from
Void | CopyFrom ( other) | Boolean
Equals (Object obj) | Inherited from | Int32
GetHashCode () | Inherited from | Type
| | | | | | | |
RASAdminEngine.Core.OutputModels.Publishing.PubLocalApp
Publishing Local Application - Android.
⇒
Android
ISerializable
IComparable
Type | Name | Description
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Application Package
⇒
⇒
AppPackage
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
AppPackageCertificate | Certificate | String
Dependencies | String | DisplayName
Boolean | Enabled | Whether the application package is enabled or not
UInt32 | Id | String
MSIXImagePath | List<PackagedApp> | PackagedApps
String | PackageName | String
Publisher | UInt32 | SiteId
ID of the Site | List<UInt32> | TagIds
Application tag IDs | DateTime | TimeCreate
Inherited from RASListObj | DateTime | TimeLastMod
Inherited from RASListObj | String | Version
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|--------------------------------------------------------------| | | Get-RASAppPackage | | | New-RASAppPackage |
RASAdminEngine.Core.OutputModels
Allowed Operating Systems
⇒
AllowedOperatingSystems
ISerializable
IComparable
Type | Name | Description
Boolean | Android | Whether Android is allowed or not.
Boolean | Chrome | Whether Chrome is allowed or not.
Boolean | iOS | Whether iOS is allowed or not.
Boolean | Linux | Whether Linux is allowed or not.
Boolean | Mac | Whether MAC OS is allowed or not.
Boolean | WebClient | Whether Web Client is allowed or not.
Boolean | Windows | Whether Windows is allowed or not.
Boolean | Wyse | Whether Wyse is allowed or not.
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.Assignment.Criteria.Types
Allowed IPs Criteria
⇒
AllowedIPsCriteria
ISerializable
IComparable
Type | Name | Description
List<IPv4CriteriaEntry> | IPv4s | IPv4 criteria list
List<IPv6CriteriaEntry> | IPv6s | IPv6 criteria list
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.ClientRulesPolicy.ClientOptions
Client Options Appearance Policy
⇒
Appearance
ISerializable
IComparable
Type | Name | Description
Boolean | Enabled | Whether Client Options Appearance policy is enabled or not.
Boolean | PromptSwitchToModern | Will prompt user to switch to modern UI.
UIType | UIType | The type of user interface used.
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Application Packages Assigned
⇒
AppPackagesAssigned
ISerializable
IComparable
Type | Name | Description
List<AppPackageAssigned> | ApplicationPackagesAssigned | List of Application Packages Assigned
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
|----------------------------------------------------------------| | | AVDDefaultSettings | | | AVDHostPool |
| RDSDefaultSettings | | | RDSDefaultSiteSettings | | | RDSHost |
RASAdminEngine.Core.OutputModels
Application Package Assigned
⇒
⇒
AppPackageAssigned
ISerializable
IComparable
Type | Name | Description
String | PackageName | Assigned application package name
Nullable<UInt32> | TagId | Inherited from AppPackageVersion
String | TagName | Inherited from AppPackageVersion
String | Version | Inherited from AppPackageVersion
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | Boolean
SetVersion (IRemoteSettings session, UInt32 | siteId, String newVersion) | String
ToString () | ### References to Types | | |
AgentState
Agent State
Values
Description
Unknown
No agent state information available
NeedsUpdate
Agent version is less than the RAS Server version
NotVerified
Agent not connected to RAS Connection Broker and cannot be used
ServerDeleted
Agent was removed from configuration.
DisabledFromSettings
Agent was disabled from configuration but it's still available in the runtime
Disconnected
Agent is not connected to any RAS Connection Broker
OK
Agent is working correctly
EnumSessionsFailed
Failed to get sessions information from the agent
RDSRoleDisabled
RD Session Host disabled or denying connections
MaxNonCompletedSessions
Maximum number of non-completed sessions limit reached
RASScheduleInProgress
Disabled (scheduler)
ConnectionFailed
Agent cannot connect to the host
InvalidCredentials
Connection to host failed because of invalid credentials
NeedsSysprep
Guest agent needs Sysprep answer file
SysPrepInProgress
SysPrep in progress on machine
CloningFailed
Cloning process failed
Synchronising
Synchronizing agent settings is in progress
LogonDrainUntilRestart
New logons disabled (drain mode) until restart
LogonDrain
New logons disabled (drain mode)
LogonDisabled
Disable user login from sessions
ForcedDisconnect
Agent forced to disconnect
CloningCanceled
Cloning is being cancelled
RASprepInProgress
RASprep in progress on machine
InstallingRDSRole
Installation of RDS role is in progress
RebootPending
Reboot of machine is pending
PortMismatch
Port mismatch found on the agent because it's already in use
NeedsDowngrade
Agent version is greater than the RAS Connection Broker version
NotApplied
Agent settings not applied
CloningInProgress
Cloning for RAS Template is in progress
MarkedForDeletion
Agent is marked for deletion
StandBy
Agent is in standby mode
UnsupportedVDIType
Provider type is not supported
FreeESXLicenseNotSupported
Free ESX License is not supported with RAS
ManagedESXNotSupported
Managed ESX License is not supported by RAS
InvalidHostVersion
Invalid Provider version
NotJoined
Tenant is invited to join or has been added to the Farm but not yet joined.
LicenseExpired
The Tenant License has expired.
JoinBroken
The Tenant failed to connect to Tenant Broker.
InUse
Agent is already connected to another farm
NotInUse
Agent is not connect to any farm
Unsupported
Agent version is no longer supported or agent's OS no longer supported
NoAvailableGateways
There are no RAS Secure Gateways that the Tenant Broker can use to process connections.
EnrollServerNotInitialized
Enrollment agent not initialized (i.e. waiting for new settings)
EnrollmentUnavailable
Enrollment agent certificated was not created
InvalidCAConfig
Invalid Certificate Authority configuration
InvalidEAUserCredentials
Invalid enrollment agent credentials
InvalidESSettings
Invalid Enrollment Agent Settings
FSLogixNotAvail
FSLogix is not available
NoDevices
HALB Instance: No HALB devices are configured
NeedsAttention
HALB Instance: One or more HALB devices are not configured OR WVD HostPool is empty (no hosts assigned)
ImageOptimizationPending
Image optimization is in pending state
ImageOptimization
Image optimization is in active state
Unavailable
Agent is not available since depending objects are not available or empty
UnderConstruction
Agent under construction
Broken
Agent broken state
NonRAS
Non RAS agent (AVD related agents)
Provisioning
A clone is being provisioned from the assigned template
Invalid
AVD object data corrupted
FSLogixNeedsUpdate
Version of installed FSLogix older than the one in configuration
NoMembersAvailable
No members in the host pool
MembersNeedUpdate
One or more members in the host pool is in need update state
FailedPerfCounters
Performance counters failed to initialize
PendingRecreation
Machine will be recreated on the last user logoff
RemovingMembers
Guest being removed from the host pool
ScalingIn
Deprecated: use RemovingMembers instead
AddingMembers
Guest being added to the host pool
ScalingOut
Deprecated: use AddingMembers instead
DeleteInProgress
A delete is currently in progress
JoiningToHostPool
A host is current being joined to a host pool
AutoUpgradeInProgress
A host is current performing an agent service upgrade automatically
AutoUpgradeInitiated
A host or hostpool is in an auto-upgrade maintenance window
ReplicaMigrationInProgress
Template replica for multi-provider distribution is migrating to a target host
AutoUpgradeFailed
A host has failed to upgrade the agent service automatically
AutoUpgradeLimitReached
A host has reached the attempt limit for automatically upgrading the agent service. Host will need to be upgraded manually
AppPackageAssignedObjType
RAS Application Package Assigned Server Object Types
Values
Description
RDSHost
Remote Desktop Session Host
RDS
Deprecated: Use RDSHost instead
RDSHostPool
RDS Host Pool
RDSGroup
Deprecated: Use RDSHostPool instead
VDIHostPool
VDI Host Pool
VDIPool
Deprecated: Use VDIHostPool instead
AVDHostPool
AVD Host Pool
RASAdminEngine.Core.OutputModels
Application Package Version info
⇒
AppPackageVersion
ISerializable
IComparable
Type | Name | Description
Nullable<UInt32> | TagId | Application version tag ID
String | TagName | Application version tag name
String | Version | Application version
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.UserProfile.FSLogix
FSLogix App Services Settings
⇒
AppServicesSettings
ISerializable
IComparable
Type | Name | Description
Boolean | UseCleanupInvalidSessions | Specifies if the 'Cleanup invalid sessions' option is enabled or
disabled. | Boolean | UseRoamRecycleBin
Specifies if the 'Roam recycle bin' option is enabled or disabled. | Boolean | UseVHDCompactDisk
Type | Name | Description
GetType () | String | ToString ()
RASAdminEngine.Core.OutputModels
RDS Application Package Status
⇒
AppPackageStatus
ISerializable
IComparable
Type | Name | Description
String | Name | The Application Package name.
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Application Package Settings
⇒
AppPackageSettings
ISerializable
IComparable
Type | Name | Description
Boolean | Enabled | Whether the application packages feature is enabled or not
Boolean | ProvisionPackageCertificatesAutomatically | Provision package certificates automatically
UInt32 | SiteId | ID of the Site for application packages settings
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.ClientRulesPolicy.Session
Sessions Advanced Settings Policy
⇒
AdvancedSettings
ISerializable
IComparable
Type | Name | Description
Boolean | AllowSrvCmd | Will allow server commands to be executed by the client
Boolean | CreateShrtCut | Creates the shortcuts on the configured server
Boolean | CredAlwaysAsk | Will always ask for the credentials
Boolean | CredSSP | Will allow for network level authentication
Boolean | DisableRUDP | Will disable rdp-udp gateway connections
Boolean | DoNotShowDriveRedirectionDlg | Does not show the redirection drive dialog
Boolean | Enabled | Whether Advanced Settings policy is enabled or not
Boolean | MailRedirection | Will redirect the mail to the client devices
Boolean | Pre2000Cred | Will use pre windows 2000 format
Boolean | PromptSrvCmd | Will confirm the server commands before executing them
Boolean | RedirPOS | Will redirect pos devices
Boolean | RegisterExt | Register file extensions associated from the server
Boolean | UrlRedirection | Will redirect url to the client device
Boolean | UseClientColors | Make use of the system client colours
Boolean | UseClientSettings | Make use of the system client settings
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Application Package Certificate
⇒
⇒
AppPackageCertificate
ISerializable
IComparable
Type | Name | Description
String | CommonName | Nullable<DateTime>
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Application Package Settings Tags
⇒
AppVersionTag
ISerializable
IComparable
Type | Name | Description
UInt32 | Id | Application version tag ID
String | Name | Application version tag name
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
| CleanupInvalidSessions | Specifies the 'Cleanup invalid sessions'.
| RoamRecycleBin | Specifies the 'Roam recycle bin'.
Specifies if the 'VHD compact disk' option is enabled or disabled. | | VHDCompactDisk
Int32 | CompareTo (Object obj) | Inherited from
Void | CopyFrom ( other) | Boolean
Equals (Object obj) | Inherited from | Int32
GetHashCode () | Inherited from | Type
| Status | The Application Package registration status.
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
List<> | Tags | Application version tags
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
ExpirationDate | | KeySize
String | PublicKey |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|------------------------------------------------| | | | | | |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
RASAdminEngine.Core.OutputModels.AVD
AVD Host Pool Assignment Settings
⇒
⇒
Assignment
ISerializable
IComparable
Type | Name | Description
String | Account | Inherited from UserFilter
String | AzureActiveDirectory | Azure Active Directory
String | AzureActiveDirectoryId | Azure Active Directory Id
String | Sid | Inherited from UserFilter
UserType | Type | Inherited from UserFilter
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.ClientRulesPolicy.Session
Sessions Audio Policy
⇒
Audio
ISerializable
IComparable
Type | Name | Description
AudioMode | AudioModes | The Audio Mode Chosen.
AudioQuality | AudioQuality | The Audio quality which was chosen
Boolean | AudioRec | Allow Audio Recording if box is ticked.
Boolean | Enabled | Whether Audio policy is enabled or not
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.AVD
AVD AutoScale Settings
⇒
AutoScale
ISerializable
IComparable
Type | Name | Description
Boolean | AutoScaleEnabled | Whether AutoScale is Enabled or not.
UInt32 | DrainRemainsBelowSec | The Remaining Drain level. (Seconds)
UInt32 | MaxServersFromTemplate | The Maximum Number of Hosts added to the template.
UInt32 | MinServersFromTemplate | The Minimum Number of Hosts added to the template.
Boolean | RemoveServersAfterDrainAndPowerOff | Remove hosts from host pool after drain and power off.
UInt32 | ServersToAddPerRequest | The amount of servers to add per request.
UInt32 | TemplateId | The Template ID.
Nullable<UInt32> | TemplateVersionId | The RAS Template Version ID.
UInt32 | WorkLoadDrain | The Drain Workload.
UInt32 | WorkloadThreshold | The Workload Threshold.
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Custom Host
⇒
AVDCustomHost
ISerializable
IComparable
Type | Name | Description
String | AzureId | Azure Id
String | Host | Host
String | HostOS | Host OS
String | HostPool | Host Pool
PowerState | HostState | Host State
String | Location | Location
UInt32 | ProviderId | Provider Id
String | ResourceGroup | Resource Group
String | VirtualNetwork | Virtual Network
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.HostPool
Auto-upgrade Settings
⇒
AutoUpgradeSettings
ISerializable
IComparable
Type | Name | Description
Double | DrainModeDurationInSecs | Drain mode duration
Boolean | Enabled | Enable auto-upgrade maintenance window
Boolean | ForceLogoffSessions | Force logoff sessions at the end of the drain mode period
List<ScheduleMessage> | Messages | Messages
RepeatType | Repeat | Recur
RepeatSpecificDays | SpecificDays | Specific Days
DateTime | StartDateTime | Start Date
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
|----------------------------------------------------------------| | | AVDDefaultSettings | | | AVDHostPool |
| RDSDefaultSettings | | | RDSDefaultSiteSettings | | | VDIDefaultSettings |
AVDBrokenReason
AVD Broken Reason
Values
Description
Ignore
Ignore
MissingObj
Azure object not present (possibly deleted)
InvalidTags
At least one RAS tag is missing
MissingDAGObj
Desktop Application Group is missing
InvalidDAGTags
RAS tags missing in Desktop Application Group
MissingDAGRoles
Role assignment(s) mismatch in Desktop Application Group more
MissingDAGWorkspaceLink
The Desktop Application Group is not linked with the workspace. The linked desktop won't be visible in the wvd client feed.
HostpoolAutomaticAssignment
Automatic assignment for personal host pool (expected direct)
MissingRAGObj
The RemoteApps Application Group is missing
InvalidRAGTags
Tags missing for the RemoteApps Application Group
MissingRAGRoles
Role assignment(s) mismatch in RemoteApps Application Group
MissingRAGWorkspaceLink
The RemoteApps Application Group is not linked with the workspace. The linked applications won't be visible in the wvd client feed.
MissingRAGRemoteApp
RAS app missing in the RemoteApps Application Group (it is admissible as long as the host pool has no host registered)
MissingObjectID
Missing Object ID
RASAdminEngine.Core.OutputModels
Azure Virtual Desktop Features Settings
⇒
AVDFeaturesSettings
ISerializable
IComparable
Type | Name | Description
Boolean | Enabled | Whether the Azure Virtual Desktop management is enabled or not
Boolean | Replicate | Whether the replication of the settings to other sites is enabled or not
UInt32 | SiteId | Site ID to which the FSLogix settings are applied
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Host
⇒
⇒
AVDHost
ISerializable
IComparable
Type | Name | Description
String | AvdAgent | AVD Agent
String | Host | Host Name
String | HostPool | Host Pool
String | Id | String
Location | Location | UInt32
ProviderId | String | ResourceGroup
Resource Group | UInt32 | SiteId
String | Workspace | Workspace
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Gallery Image
⇒
AVDGalleryImage
ISerializable
IComparable
Type | Name | Description
String | AzureId | Azure Id
String | Image | Image
String | Publisher | Publisher
String | Version | Version
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Default Settings
⇒
AVDDefaultSettings
ISerializable
IComparable
Type | Name | Description
UInt32 | SiteId | Site ID
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
| ClientFeatureSet | Client feature set (Standard, Advanced or Advanced with fallback)
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Void | CheckIfSettingsChangeAllowed () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|--------------------------------------------------------------| | | | | | |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
| Action | Action
| Agent | Specifies the 'Agent' object.
| AppPackagesAssigned | Specifies the 'Application Packages' object.
| AutoUpgrade | Specifies the 'Auto-upgrade' object.
Nullable<> | DefObjType | The Default Object Type
| Optimization | Specifies the 'Image Optimization' object.
| RDPPrinter | Specifies the 'RDP Printer' object.
| UserProfile | Specifies the 'User Profile' object.
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
RASAdminEngine.Core.OutputModels.AVD
AVD Host Pool Status
⇒
⇒
AVDHostPoolStatus
ISerializable
IComparable
Type | Name | Description
AgentState | AgentState | Agent State.
Nullable<AVDBrokenReason> | BrokenReason | AVD Broken Reason.
String | Id | Inherited from RASAgentInfo
String | Name | AVD Host Pool name.
RASServerType | ServerType | Inherited from RASAgentInfo
UInt32 | SiteId | Inherited from RASAgentInfo
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|----------------------------------------------------------------------| | | Get-RASAgent | | | Get-RASAVDHostPoolStatus |
RASAdminEngine.Core.OutputModels
AVD Host System Information
⇒
⇒
AVDHostSysInfo
ISerializable
IComparable
Type | Name | Description
AgentState | AgentState | Inherited from RASAgentInfo
String | AgentVer | HostAssignmentType
Assignment | String | AVDAgent
AVD Agent name. | UInt32 | CPULoad
UInt32 | DiskRead | String
Disks | UInt32 | DiskWrite
Boolean | Enabled | String
HostIP | String | Id
Inherited from RASAgentInfo | RASLogLevel | LogLevel
String | MachineId | UInt32
MemLoad | HostPowerState | PowerState
String | Server | String
ServerOS | RASServerType | ServerType
Inherited from RASAgentInfo | String | ServiceStartTime
UInt32 | SiteId | Inherited from RASAgentInfo
String | SubnetName | Subnet name.
String | SystemBootTime | UInt32
UnhandledExceptions | String | User
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|--------------------------------------------------------------| | | Get-RASAgent | | | Get-RASAVDHostStatus |
RASAdminEngine.Core.OutputModels
AVD Host System Session Processes Information
⇒
⇒
⇒
AVDHostSysSessionApp
ISerializable
IComparable
Type | Name | Description
AgentState | AgentState | Inherited from RASAgentInfo
String | AgentVer | HostAssignmentType
Assignment | String | AVDAgent
Inherited from AVDHostSysInfo | UInt32 | CPULoad
UInt32 | DiskRead | String
Disks | UInt32 | DiskWrite
Boolean | Enabled | String
HostIP | String | Id
Inherited from RASAgentInfo | RASLogLevel | LogLevel
String | MachineId | UInt32
MemLoad | HostPowerState | PowerState
String | Server | String
ServerOS | RASServerType | ServerType
Inherited from RASAgentInfo | String | ServiceStartTime
AVDSessionApp | Session | The AVD Session.
UInt32 | SiteId | Inherited from RASAgentInfo
String | SubnetName | Inherited from AVDHostSysInfo
String | SystemBootTime | UInt32
UnhandledExceptions | String | User
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Marketplace Version
⇒
AVDMarketplaceVersion
ISerializable
IComparable
Type | Name | Description
String | AzureId | String
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Gallery
⇒
AVDGallery
ISerializable
IComparable
Type | Name | Description
String | AzureId | Azure Id
String | Name | Name
String | ResourceGroup | Resource Group
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Location
⇒
AVDLocation
ISerializable
IComparable
Type | Name | Description
String | DisplayName | Display Name
String | Name | Name
ResourceType | ResourceType | Resource Type
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Predefiend VM Images
⇒
AVDPredefinedVMImage
ISerializable
IComparable
Type | Name | Description
String | DisplayName | Image name
HostSessionType | ImageSessionType | Image Type multi-session or single-session.
String | Offer | The name of a group of related images created by a publisher
String | Publisher | The organization that created the image
String | Sku | An instance of an offer, such as a major release of a distribution
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
Azure Virtual Desktop Host Pool
⇒
⇒
AVDHostPool
ISerializable
IComparable
Type | Name | Description
ActionSettings | Action | Action
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
HostPoolAgentSettings | Agent | Specifies the 'Host Pool settings' object.
AppPackagesAssigned | AppPackagesAssigned | List Of Application Packages Assigned.
List<Assignment> | Assignments | The Azure Virtual Desktop Host Pool Assignment Settings
AutoUpgradeSettings | AutoUpgrade | Specifies the 'Auto-upgrade' object.
String | AzureId | The Azure ID
Configuration | Configuration | The Azure Virtual Desktop Host Pool Configuration Settings
String | Description | The Description of the Host Pool
Boolean | Enabled | Whether host pool is enabled or not.
String | FriendlyName | The Friendly Name of the Host Pool
UInt32 | Id | Nullable<Boolean>
InheritDefaultActionsSettings | If true, default Actions settings will be inherited. | Boolean
InheritDefaultAgentSettings | If true, default Agent settings will be inherited. | Boolean
InheritDefaultAppPackageSettings | If true, default app package settings will be inherited. | Boolean
InheritDefaultAutoUpgradeSettings | If true, default Auto-upgrade settings will be inherited. | Nullable<Boolean>
InheritDefaultOptimizationSettings | If true, default optimization settings will be inherited. | Boolean
InheritDefaultRDPPrinterSettings | If true, default Printing settings will be inherited. | Boolean
InheritDefaultUserProfileSettings | If true, default User Profile settings will be inherited. | String
LinkedDesktopApplicationGroup | The Linked Desktop Application Group. | String
LinkedRemoteApplicationGroup | The Linked Remote Application Group. | String
Location | The location of the Host Pool | String
Name | The Name of the Host Pool | ImageOptimization
Optimization | Specifies the 'Image Optimization' object. | AVDProvisioningSettings
ProvisioningSettings | The Azure Virtual Desktop Host Pool Provisioning Settings | RDPPrinterSettings
RDPPrinter | Specifies the 'RDP Printer' object. | String
ResourceGroup | The Resource Group of the Host Pool | DateTime
TimeCreate | Inherited from RASListObj | DateTime
TimeLastMod | Inherited from RASListObj | UserProfileSettings
UserProfile | Specifies the 'User Profile' object. | UInt32
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|----| | | Add-RASAVDHostPoolAssignment | | | Get-RASAVDHostPool |
| Get-RASAVDHostPoolStatus | | | New-RASAVDHostPool | | | Remove-RASAVDHostPool |
RASAdminEngine.Core.OutputModels.Provider
AVD Provider
⇒
⇒
⇒
AVDProvider
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
ADType | ADType | AD Type.
String | Description | Boolean
Enabled | String | FeedURL
The Feed URL. | String | GraphURL
The Graph URL. | UInt32 | HostPort
Inherited from Provider | UInt32 | Id
Boolean | InheritDefaultAgentSettings | Inherited from Provider
String | Name | Inherited from Provider
UInt32 | PreferredBrokerId | Inherited from Provider
String | ProviderUsername | Inherited from Provider
String | Server | Inherited from Provider
UInt32 | SiteId | DateTime
TimeCreate | Inherited from RASListObj | DateTime
TimeLastMod | Inherited from RASListObj | ProviderMajorType
Type | Inherited from Provider | String
VDIAgent | Inherited from Provider | VDIAzureInfo
VDIAzureCloudInfo | VDI Azure Cloud Info. | UInt32
VDIPort | Inherited from Provider | AVDVersion
Version | Specifies the AVD Provider type version. | String
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
ProviderMajorType | GetHypervisorType () | Type
GetType () | Boolean | IsHWGPUSupported ()
Inherited from Provider | String | ToString ()
RASAdminEngine.Core.OutputModels.AVD
Azure Virtual Desktop Host Pool Provisioning Settings
⇒
⇒
⇒
AVDProvisioningSettings
ISerializable
IComparable
Type | Name | Description
Boolean | OverwriteSize | Whether Overwrite Size is Enabled or not.
Type | Name | Description
String | ToString () | ### References to Types
RASAdminEngine.Core.OutputModels.AVD
AVD Publisher
⇒
AVDPublisher
ISerializable
IComparable
Type | Name | Description
String | AzureId | String
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Resource Group
⇒
AVDResourceGroup
ISerializable
IComparable
Type | Name | Description
String | AzureId | Azure Id
String | Location | Location
String | Name | Name
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels
AVD Session Processes Information
⇒
⇒
AVDSessionApp
ISerializable
IComparable
Type | Name | Description
String | HostId | UInt32
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Offer
⇒
AVDOffer
ISerializable
IComparable
Type | Name | Description
String | AzureId | String
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Stock Keeping Unit
⇒
AVDSKU
ISerializable
IComparable
Type | Name | Description
String | AzureId | String
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
| AutoScale | Specifies the 'AutoScale' object.
| DefaultPowerState | Inherited from
UInt32 | Duration | Inherited from
String | HostName | Inherited from
UInt32 | MaxHosts | Inherited from
UInt32 | PreCreatedHosts | Inherited from
| VMSize | The Azure Virtual Dekstop 'VMSize' object.
Int32 | CompareTo (Object obj) | Inherited from
Void | CopyFrom ( other) | Inherited from
Void | CopyFrom ( | other)
Inherited from | Boolean | Equals (Object obj)
Inherited from | Int32 | GetHashCode ()
Inherited from | Type | GetType ()
| | | |------------------------------------------| | | |
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|--------------------------------------------------------------------| | | | | | |
List<> | Applications | The list of Session Processes.
UInt32 | AuthenticationDuration | Inherited from
| AuthenticationType | Inherited from
UInt32 | BandwidthAvailability | Inherited from
UInt32 | BandwidthUsage | Inherited from
String | ClientIPAddress | Inherited from
String | ClientOS | Inherited from
String | ClientOSVersion | Inherited from
UInt32 | ClientPolicyId | Inherited from
UInt32 | ClientPolicyVersion | Inherited from
String | ClientVersion | Inherited from
| ColourDepth | Inherited from
UInt32 | ConnectionDuration | Inherited from
| ConnectionMode | Inherited from
| ConnectionQuality | Inherited from
UInt32 | DesktopLoadTime | Inherited from
String | DeviceName | Inherited from
String | DisconnectReason | Inherited from
UInt32 | GroupPolicyLoadTime | Inherited from
UInt32 | HorizontalResolution | Inherited from
HostPreparation | Inherited from | Nullable<DateTime>
IdleStartTime | Inherited from | UInt32
IdleTime | Inherited from | UInt32
IncomingData | Inherited from | String
IP | Inherited from | UInt32
LastReconnects | Inherited from | UInt32
Latency | Inherited from | UInt32
LogonDuration | Inherited from | UInt32
LogonOthersDuration | Inherited from | DateTime
LogonTime | Inherited from |
MFAProvider | Inherited from | UInt32
OutgoingData | Inherited from |
Protocol | Inherited from | UInt32
RASPolicyLookup | Inherited from | UInt32
Reconnects | Inherited from | UInt32
RFICount | Inherited from | List<>
RFIInfoList | Inherited from | UInt32
ServerID | Inherited from | UInt32
SessionID | Inherited from | UInt32
SessionLength | Inherited from |
State | Inherited from | UInt32
ThemeID | Inherited from |
Type | Inherited from | String
User | Inherited from | UInt32
UserProfileLoadTime | Inherited from |
UserProfileType | Inherited from | UInt32
UXEvaluator | Inherited from | UInt32
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
RASAdminEngine.Core.OutputModels.AVD
AVD Workspace
⇒
⇒
AVDWorkspace
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
String | AzureId | Azure Id
String | Description | Description
Boolean | Enabled | Enabled
String | FriendlyName | Friendly Name
UInt32 | Id | String
Location | Location | String
Name | Name | UInt32
ProviderId | Provider Id | String
ResourceGroup | Resource Group | DateTime
TimeCreate | Inherited from RASListObj | DateTime
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|------------------------------------------------------------------------| | | Get-RASAVDWorkspace | | | Get-RASAVDWorkspaceStatus |
| New-RASAVDWorkspace | | | Remove-RASAVDWorkspace | | | Set-RASAVDWorkspace |
RASAdminEngine.Core.OutputModels.AVD
AVD Virtual Network
⇒
AVDVirtualNetwork
ISerializable
IComparable
Type | Name | Description
String | AzureId | Azure Id
String | Name | Name
List<AVDSubnet> | Subnets | Subnets
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.AVD
AVD VM Size
⇒
AVDVMSize
ISerializable
IComparable
Type | Name | Description
UInt32 | DataDisk | Data Disk Count
String | Family | Family
String | MaximumIOPS | Maximum IOPS
String | Offering | Offering
BinaryChoice | PremiumDiskSupport | Premium Disk Support
String | RAM | RAM (GiB)
UInt32 | TempStorage | Temparary Storage (MB)
UInt32 | VCPUs | Virtual CPUs
String | VMSize | VM Size
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Virtual Network
⇒
AVDSubnet
ISerializable
IComparable
Type | Name | Description
String | AddressPrefix | Address Prefix
String | AzureId | Azure Id
String | Name | Name
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Amazon Web Service Subnet
⇒
AWSSubnet
ISerializable
IComparable
Type | Name | Description
String | AvailabilityZone | Availability Zone
String | Id | Id
String | IPv4CIDR | IPv4 CIDR
String | Name | Name
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.HostPool.ProviderSettings
Amazon Web Service Provider Settings
⇒
AWSProviderSettings
ISerializable
IComparable
Type | Name | Description
List<String> | SubnetIDs | Subnet IDs.
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels.AVD
AVD Workspace Status
⇒
⇒
AVDWorkspaceStatus
ISerializable
IComparable
Type | Name | Description
String | Location | Location.
String | Name | AVD Host Pool name.
UInt32 | ProviderId | Provider Id.
String | ResourceGroup | Resource Group.
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.Provider
Amazon Web Service Elastic Compute Cloud
⇒
⇒
⇒
AWSEC2Provider
ISerializable
IComparable
Type | Name | Description
String | AccessKeyId | Access Key Id
AllowDragAndDrop | Boolean | AllowFileTransfer
AllowURLAndMailRedirection | String | Description
String | DirectAddress | Boolean
EnableAppMonitoring | Boolean | Enabled
Boolean | EnableDriveRedirectionCache | Boolean
EnablePrinting | Boolean | EnableTWAIN
Boolean | EnableWIA | String
EndpointUrl | Endpoint Url | String
FileTransferLocation | Boolean | FileTransferLockLocation
Id | Boolean | InheritDefaultAgentSettings
RegionCode | Region Code | String
RegionName | Region Name | Boolean
RemoveClientNameFromPrinterName | Boolean | RemoveSessionNumberFromPrinterName
UInt32 | SessionLogoffTimeout | UInt32
SessionTimeout | UInt32 | SiteId
Boolean | SupportShellURLNamespaceObjects | DateTime
UseAllGuests | Boolean | UseDedicatedVDIAgent
Boolean | UseDefaultPrinterSettings | Boolean
UseRemoteApps | String | VDIAgent
Type | Name | Description
GetType () | Boolean | IsHWGPUSupported ()
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
| AgentState | Agent State.
Nullable<> | BrokenReason | AVD Broken Reason.
String | Id | Inherited from
| ServerType | Inherited from
UInt32 | SiteId | Inherited from
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|------------------------------------------------------------------------| | | | | | |
String | AdminCreate | Inherited from
List<> | AdminCredentials | String
AdminLastMod | Inherited from | Boolean
Boolean | AllowRemoteExec |
| FileTransferMode | UInt32
HostPort | Inherited from | UInt32
Inherited from | | LocationType
Location Type | | ManageRDPTransportProtocol
String | Name | Inherited from
UInt32 | PreferredBrokerId | Inherited from
| PrinterNameFormat | String
ProviderUsername | Inherited from | String
String | Server | Inherited from
TimeCreate | Inherited from | DateTime
TimeLastMod | Inherited from |
Type | Inherited from | Boolean
Inherited from | UInt32 | VDIPort
Inherited from | | Version
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
| GetHypervisorType () | Type
Inherited from | String | ToString ()
RASAdminEngine.Core.OutputModels.Provider
Azure Provider
⇒
⇒
⇒
AzureProvider
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
Boolean | AllowDragAndDrop | Boolean
AllowFileTransfer | Boolean | AllowRemoteExec
AllowURLAndMailRedirection | AllowURLAndMailRedirection | String
Description | String | DirectAddress
Boolean | EnableAppMonitoring | Boolean
Enabled | Boolean | EnableDriveRedirectionCache
Boolean | EnablePrinting | Boolean
EnableTWAIN | Boolean | EnableWIA
String | FileTransferLocation | Boolean
FileTransferLockLocation | FileTransferControlMode | FileTransferMode
UInt32 | HostPort | Inherited from Provider
UInt32 | Id | Boolean
InheritDefaultAgentSettings | Inherited from Provider | ManageRDPTransportProtocol
ManageRDPTransportProtocol | String | Name
Inherited from Provider | UInt32 | PreferredBrokerId
Inherited from Provider | PrnNameFormat | PrinterNameFormat
String | ProviderUsername | Inherited from Provider
Boolean | RemoveClientNameFromPrinterName | Boolean
RemoveSessionNumberFromPrinterName | String | Server
Inherited from Provider | UInt32 | SessionLogoffTimeout
UInt32 | SessionTimeout | UInt32
SiteId | Boolean | SupportShellURLNamespaceObjects
DateTime | TimeCreate | Inherited from RASListObj
DateTime | TimeLastMod | Inherited from RASListObj
ProviderMajorType | Type | Inherited from Provider
Boolean | UseAllGuests | Boolean
UseDedicatedVDIAgent | Boolean | UseDefaultPrinterSettings
Boolean | UseRemoteApps | String
VDIAgent | Inherited from Provider | VDIAzureInfo
VDIAzureCloudInfo | VDI Azure Cloud Info. | UInt32
VDIPort | Inherited from Provider | AzureVersion
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
ProviderMajorType | GetHypervisorType () | Type
GetType () | Boolean | IsHWGPUSupported ()
Inherited from Provider | String | ToString ()
RASAdminEngine.Core.OutputModels
RAS Connection Broker Auto Promotion
⇒
BrokerAutoPromotion
ISerializable
IComparable
Type | Name | Description
UInt32 | AutoPromoteAfterMins | The amount of time (in mins) required to enable auto promotion.
Boolean | Enabled | Whether Auto Promotion is enabled.
Boolean | FailbackEnabled | Whether Failback is enabled.
Boolean | Replicate | Whether Replicate is enabled.
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels
Connection Broker
⇒
⇒
Broker
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
String | AlternativeIPs | Alternative IPs to access the RAS Connection Broker.
String | Description | Boolean
Enabled | UInt32 | Id
String | IP | IP address of RAS Connection Broker.
Boolean | MarkedForDeletion | Whether the RAS Connection Broker is marked for deletion or not.
UInt32 | Priority | Priority of the specified RAS Connection Broker.
String | Server | UInt32
SiteId | Boolean | Standby
Whether the RAS Connection Broker is in standby mode or not. | DateTime | TimeCreate
Inherited from RASListObj | DateTime | TimeLastMod
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|----| | | Get-RASBroker | | | Get-RASBrokerStatus |
| Invoke-RASBrokerPromoteToPrimary | | | New-RASBroker | | | New-RASProvider |
| New-RASRDSHostPool | | | Remove-RASBroker | | | Set-RASBroker |
| Set-RASBrokerPriority | | | Set-RASGateway | | | Set-RASGatewayDefaultSettings |
| Set-RASProvider | | | Set-RASRDSDefaultSettings | | | Set-RASRDSHost |
RASAdminEngine.Core.OutputModels.AgentDiagnostic
Broker Agent Diagnostic
⇒
BrokerAgentDiagnostic
ISerializable
IComparable
Type | Name | Description
RASAgentDiagnosticType | AgentDiagnosticType | String
AgentVersion | Boolean | CanTakeover
Whether the Broker can be taken over or not. | String | IP
Broker IP. | String | OSVersion
String | PrimaryServer | Primary Server.
String | Server | BrokerDiagnosticState
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.HostPool
Host Pool Base Provisioning Settings
⇒
BaseProvisioningSettings
ISerializable
IComparable
Type | Name | Description
DefaultPowerState | DefaultPowerState | The Default Power State
String | HostName | The Host name format. All Host created from the template will have this
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Void | CopyFrom (BaseProvisioningSettings | other)
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
|------------------------------------------------------------------| | | AVDProvisioningSettings | | | ProvisioningSettings |
RASAdminEngine.Core.OutputModels
The Certificate
⇒
⇒
Certificate
ISerializable
IComparable
Type | Name | Description
String | AdminCreate | Inherited from RASListObj
String | AdminLastMod | Inherited from RASListObj
String | AlternateNames | The alternate names of the certificate.
String | CommonName | String
Description | The description of the certificate. | Boolean
Enabled | Whether the certificate is enabled or not. | Nullable<DateTime>
ExpirationDate | UInt32 | Id
String | Intermediate | The intermediate.
CertificateKeySize | KeySize | String
Name | Certificate Name. | String
PublicKey | String | Request
The certificate request. | UInt32 | SiteId
ID of the site. | CertificateStatus | Status
DateTime | TimeCreate | Inherited from RASListObj
DateTime | TimeLastMod | Inherited from RASListObj
CertificateType | Type | Whether the certificate is Self-Signed, Imported or Requested.
CertificateUsages | Usage | A set of assigned certificate usages. To form a set of usages 'OR'
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
|----| | | Get-RASCertificate | | | Invoke-RASCertificateCmd |
| Invoke-RASExportCertificate | | | New-RASCertificate | | | Remove-RASCertificate |
| Set-RASCertificate | | | Set-RASGateway | | | Set-RASGatewayDefaultSettings |
RASAdminEngine.Core.OutputModels.ClientRulesPolicy.Session.Display
Sessions Browser Policy
⇒
Browser
ISerializable
IComparable
Type | Name | Description
OpenApplicationsIn | BrowserOpenIn | Will open the applications depending on what the client selected
Boolean | Enabled | Whether Display Settings Browser is enabled or not
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |
RASAdminEngine.Core.OutputModels
Connection Broker System Information
⇒
⇒
BrokerSysInfo
ISerializable
IComparable
Type | Name | Description
String | AgentVer | UInt32
CPULoad | UInt32 | DiskRead
UInt32 | DiskWrite | Boolean
Enabled | String | Id
String | MachineId | UInt32
MemLoad | String | Server
ServiceStartTime | UInt32 | SiteId
Type | Name | Description
Type | GetType () | String
ToString () | ### References to Commands | | |
| AgentState | Inherited from
Inherited from | | LogLevel
String | ServerOS |
ServerType | Inherited from | String
Inherited from | String | SystemBootTime
Int32 | CompareTo (Object obj) | Inherited from
Boolean | Equals (Object obj) | Inherited from
Int32 | GetHashCode () | Inherited from
|------------------------------------------------------------| | | | | | |
RASAdminEngine.Core.OutputModels
Check For Update
⇒
CheckForUpdate
ISerializable
IComparable
Type | Name | Description
String | Message | The Message
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Commands | | |
RASAdminEngine.Core.OutputModels.ClientRulesPolicy.LocalDevicesAndResources
Settings about the 'Multimedia Redirection for AVD'
⇒
AVDMultimediaRedirection
ISerializable
IComparable
Type | Name | Description
Boolean | AVDMultimediaRedir | If box is checked enable Multimedia Redirection for AVD
Boolean | Enabled | Whether 'Multimedia Redirection for AVD' policy is enabled or not
Type | Name | Description
Int32 | CompareTo (Object obj) | Inherited from RASSerilazableObj
Boolean | Equals (Object obj) | Inherited from RASSerilazableObj
Int32 | GetHashCode () | Inherited from RASSerilazableObj
Type | GetType () | String
ToString () | ### References to Types | | |