NAMESPACE

RASAdminEngine.Core.OutputModels.HostPool

DESCRIPTION

Action Settings

INHERITED FROM

RASSerilazableObj

⇒

ActionSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

PerformAction

PerformAction

Perform action on session change.

UInt32

PerformActionAfterSec

Perform action after (in seconds).

SessionAction

SessionAction

Session action.

PUBLIC METHODS

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

NAME

AcmeCommand

DESCRIPTION

Acme command

Values

Description

Retry

Retry command

Renew

Renew command

Revoke

Revoke command

References to Commands

NAME

AccessType

DESCRIPTION

Access type options

Values

Description

DenyCriteriaWhen

Deny Criteria when

AllowCriteriaWhen

Allow Criteria when

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

AD Integration Settings

INHERITED FROM

RASSerilazableObj

⇒

ADIntegrationSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

The site ID to which the AD integration settings refer to.

PUBLIC METHODS

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

NAME

ActionType

DESCRIPTION

The action type for add registry entry

Values

Description

Add

Add

Modify

Modify

Delete

Delete

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

RAS Admin

INHERITED FROM

RASSerilazableObj

⇒

RASListObj

⇒

AdminAccount

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

Admin Type: 0 = User, 1 = Group, 2 = User Group

PUBLIC METHODS

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

NAME

AcceptedSSLVersion

DESCRIPTION

Accepted SSL Versions

Values

Description

TLSv1

TLS v1 - TLS v1.3

TLSv1_1

TLS v1.1 - TLS v1.3

TLSv1_2

TLS v1.2 - TLS v1.3

TLSv1_3

TLS v1.3 only (strong)

References to Commands

References to Types

NAME

AcmeRevokeReason

DESCRIPTION

Acme Revoke Reason

Values

Description

Unspecified

Unspecified reason

KeyCompromise

Key Compromise reason

Superseded

Superseded reason

CessationOfOperation

Cessation Of Operation reason

References to Commands

NAME

AccelerationMode

DESCRIPTION

Acceleration Mode Type.

Values

Description

None

None

Basic

Basic

RemoteFx

Remote FX

RemoteFxAdaptive

Remote FX Adaptive

AVCAdaptive

AVC Adaptive

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

RAS Admin Session

INHERITED FROM

⇒

AdminSession

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

ComputerName

Computer name of the session.

UInt32

Id

String

IP

IP of the session.

Language

Language of the session

DateTime

LogonTime

Session Logon Time.

State

State of session.

UInt32

UserId

ID of the user of the session.

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAME

AdminNotify

DESCRIPTION

Admin Notify

Values

Description

None

None

Email

Email

References to Commands

References to Types

NAME

AdminType

DESCRIPTION

Admin Type

Values

Description

User

User

Group

Group

UserGroup

UserGroup

References to Types

NAME

AllocationType

DESCRIPTION

Allocation Type values.

Values

Description

Dynamic

Dynamic

Full

Full

References to Commands

References to Types

NAME

ADType

DESCRIPTION

Active Directory Domain Service Type

Values

Description

WindowsServerADDS

Windows Server AD DS

AzureADDS

Azure AD DS

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.HostPool

DESCRIPTION

Host Pool Agent Settings

INHERITED FROM

RASSerilazableObj

⇒

AgentSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

Boolean

AllowRemoteExec

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

AllowURLAndMailRedirection

AllowURLAndMailRedirection

Specifies the 'Allow Client URL/Mail Redirection'.

UInt32

DisconnectActiveSessionAfter

Disconnect active session after (in seconds). 0 for 'Never'.

DragAndDropModeValue

DragAndDropMode

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 allowed.

FileTransferControlMode

FileTransferMode

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'.

ManageRDPTransportProtocol

ManageRDPTransportProtocol

Manage RDP transport protocol.

UInt32

SessionReadinessTimeout

Session readiness timeout (in seconds).

Boolean

SupportShellURLNamespaceObjects

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Inherited from RASSerilazableObj

Void

CopyFrom (AgentSettings other)

Boolean

Equals (Object obj)

Inherited from RASSerilazableObj

Int32

GetHashCode ()

Inherited from RASSerilazableObj

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.Provider

DESCRIPTION

Admin Credentials

INHERITED FROM

RASSerilazableObj

⇒

AdminCredential

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

Boolean

Enabled

Whether credentials are enabled or not.

UInt32

Priority

The priority

String

Username

Username

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Allowed Operating Systems

INHERITED FROM

⇒

AllowedOperatingSystems

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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.

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.Assignment.Criteria.Types

DESCRIPTION

Allowed IPs Criteria

INHERITED FROM

RASSerilazableObj

⇒

AllowedIPsCriteria

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

List<IPv4CriteriaEntry>

IPv4s

IPv4 criteria list

List<IPv6CriteriaEntry>

IPv6s

IPv6 criteria list

PUBLIC METHODS

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

NAME

AllowClientMode

DESCRIPTION

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

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package Assigned

INHERITED FROM

RASSerilazableObj

⇒

AppPackageVersion

⇒

AppPackageAssigned

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAME

AgentState

DESCRIPTION

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

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.ClientRulesPolicy.Session

DESCRIPTION

Sessions Advanced Settings Policy

INHERITED FROM

⇒

AdvancedSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package

INHERITED FROM

⇒

⇒

AppPackage

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AdminCreate

String

AdminLastMod

Certificate

String

Dependencies

String

DisplayName

Boolean

Enabled

Whether the application package is enabled or not

UInt32

Id

String

MSIXImagePath

PackagedApps

String

PackageName

String

Publisher

UInt32

SiteId

ID of the Site

List<UInt32>

TagIds

Application tag IDs

DateTime

TimeCreate

DateTime

TimeLastMod

String

Version

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package Settings

INHERITED FROM

RASSerilazableObj

⇒

AppPackageSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

List<AppVersionTag>

Tags

Application version tags

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package Certificate

INHERITED FROM

RASSerilazableObj

⇒

RASListObj

⇒

AppPackageCertificate

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

CommonName

Nullable<DateTime>

ExpirationDate

CertificateKeySize

KeySize

String

PublicKey

CertificateStatus

Status

PUBLIC METHODS

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

NAME

AppPackageRegistrationStatus

DESCRIPTION

Application Package Registration Status

Values

Description

NotApplied

Status not applied

ImageMountingFailed

Failed to mount image

StagingFailed

Failed to stage

StagingSuccessful

Staging passed

Unsupported

Application Package unsupported

References to Types

NAME

AppPackageAssignedObjType

DESCRIPTION

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 (Experimental)

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels.UserProfile.FSLogix

DESCRIPTION

FSLogix App Services Settings

INHERITED FROM

⇒

AppServicesSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

CleanupInvalidSessions

Specifies the 'Cleanup invalid sessions'.

RoamRecycleBin

Specifies the 'Roam recycle bin'.

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

Specifies if the 'VHD compact disk' option is enabled or disabled.

VHDCompactDisk

Specifies the 'VHD compact disk'.

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Void

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Host Pool Assignment Settings

INHERITED FROM

⇒

⇒

Assignment

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

Account

String

AzureActiveDirectory

Azure Active Directory

String

AzureActiveDirectoryId

Azure Active Directory Id

String

Sid

Type

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Packages Assigned

INHERITED FROM

⇒

AppPackagesAssigned

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

ApplicationPackagesAssigned

List of Application Packages Assigned

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package Version info

INHERITED FROM

⇒

AppPackageVersion

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

Nullable<UInt32>

TagId

Application version tag ID

String

TagName

Application version tag name

String

Version

Application version

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAME

AttributeType

DESCRIPTION

SAML Attributes

Values

Description

UserPrincipalName

User Principal Name

ImmutableID

Immutable ID

SID

SID

sAMAccountName

sAMA Account Name

Custom

Custom

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

RDS Application Package Status

INHERITED FROM

RASSerilazableObj

⇒

AppPackageStatus

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

Name

The Application Package name.

AppPackageRegistrationStatus

Status

The Application Package registration status.

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Application Package Settings Tags

INHERITED FROM

RASSerilazableObj

⇒

AppVersionTag

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

UInt32

Id

Application version tag ID

String

Name

Application version tag name

PUBLIC METHODS

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

NAME

AuthenticationTypes

DESCRIPTION

Authentication Type

Values

Description

UsernamePassword

UsernamePassword

SmartCard

SmartCard

Web

Web

WebCredentials

Web + Credentials

UsernamePasswordOrSmartCard

UsernamePasswordOrSmartCard

References to Commands

References to Types

NAME

AssignmentType

DESCRIPTION

Assignment Type

Values

Description

None

None

User

User

Device

Device

References to Types

NAME

AuthType

DESCRIPTION

Authentication Type.

Values

Description

Credentials

Credentials

SingleSignOn

Single Sign-On

SmartCard

Smart Card

Web

Web

WebCredentials

Web + Credentials

References to Commands

References to Types

NAME

AVDBrokenReason

DESCRIPTION

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

References to Types

NAME

AudioMode

DESCRIPTION

Audio Mode Type.

Values

Description

BringToThisComputer

Bring To This Computer

DoNotPlay

Do Not Play

LeaveAtRemoteComputer

Leave At Remote Computer

References to Commands

References to Types

NAME

AudioQuality

DESCRIPTION

Audio Quality Type.

Values

Description

AdjustDynamically

Adjust Dynamically

UseMediumQuality

Use Medium Quality

UseUncompressedQuality

Use Uncompressed Quality

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD AutoScale Settings

INHERITED FROM

RASSerilazableObj

⇒

AutoScale

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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.

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

Azure Virtual Desktop Features Settings

INHERITED FROM

RASSerilazableObj

⇒

AVDFeaturesSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

ClientFeatureSetType

ClientFeatureSet

Client feature set (Standard, Advanced or Advanced with fallback)

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

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.HostPool

DESCRIPTION

Auto-upgrade Settings

INHERITED FROM

RASSerilazableObj

⇒

AutoUpgradeSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Gallery

INHERITED FROM

RASSerilazableObj

⇒

AVDGallery

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AzureId

Azure Id

String

Name

Name

String

ResourceGroup

Resource Group

PUBLIC METHODS

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

NAME

AVDCommand

DESCRIPTION

VDI Process command

Values

Description

CancelSchedule

Cancel Schedule

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Gallery Image

INHERITED FROM

RASSerilazableObj

⇒

AVDGalleryImage

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AzureId

Azure Id

String

Image

Image

String

Publisher

Publisher

String

Version

Version

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.ClientRulesPolicy.Session

DESCRIPTION

Sessions Audio Policy

INHERITED FROM

RASSerilazableObj

⇒

Audio

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAME

AllowURLAndMailRedirection

DESCRIPTION

URL and Mail Redirection values.

Values

Description

Disabled

Disabled

Enabled

Enabled

EnabledWithAppRegistration

Enabled with application registration

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.ClientRulesPolicy.ClientOptions

DESCRIPTION

Client Options Appearance Policy

INHERITED FROM

RASSerilazableObj

⇒

Appearance

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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.

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Host

INHERITED FROM

⇒

⇒

AVDHost

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

Type

Name

Description

Void

CheckIfSettingsChangeAllowed ()

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAME

AllowMultiMonitor

DESCRIPTION

Multi-monitor options for published desktops.

Values

Description

Enabled

Enable

Disabled

Disable

UseClientSettings

Use Client Settings

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Host Pool Status

INHERITED FROM

⇒

⇒

AVDHostPoolStatus

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

AgentState

Agent State.

BrokenReason

AVD Broken Reason.

String

Id

String

Name

AVD Host Pool name.

ServerType

UInt32

SiteId

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAME

AVDDefObjType

DESCRIPTION

AVD Default Object Type

Values

Description

AVDMultiSessionDefaultSettings

AVD Multi-Session Default Settings

AVDSingleSessionDefaultSettings

AVD Single-Session Default Settings

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

AVD Host System Information

INHERITED FROM

RASSerilazableObj

⇒

RASAgentInfo

⇒

AVDHostSysInfo

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Location

INHERITED FROM

RASSerilazableObj

⇒

AVDLocation

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

DisplayName

Display Name

String

Name

Name

ResourceType

ResourceType

Resource Type

PUBLIC METHODS

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

NAME

AVDLicenseType

DESCRIPTION

The AVD License Type

Values

Description

DoNotConfigure

Do Not Configure

WindowsClient

Windows Client

WindowsServer

Windows Server

References to Commands

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Default Settings

INHERITED FROM

RASSerilazableObj

⇒

AVDDefaultSettings

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

ActionSettings

Action

Action

HostPoolAgentSettings

Agent

Specifies the 'Agent' object.

AppPackagesAssigned

AppPackagesAssigned

Specifies the 'Application Packages' object.

AutoUpgradeSettings

AutoUpgrade

Specifies the 'Auto-upgrade' object.

Nullable<AVDDefObjType>

DefObjType

The Default Object Type

ImageOptimization

Optimization

Specifies the 'Image Optimization' object.

RDPPrinterSettings

RDPPrinter

Specifies the 'RDP Printer' object.

UInt32

SiteId

Site ID

UserProfileSettings

UserProfile

Specifies the 'User Profile' object.

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

AVD Host System Session Processes Information

INHERITED FROM

RASSerilazableObj

⇒

RASAgentInfo

⇒

AVDHostSysInfo

⇒

AVDHostSysSessionApp

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Custom Host

INHERITED FROM

RASSerilazableObj

⇒

AVDCustomHost

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

Azure Virtual Desktop Host Pool

INHERITED FROM

RASSerilazableObj

⇒

RASListObj

⇒

AVDHostPool

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

WorkspaceId

The Workspace ID.

PUBLIC METHODS

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

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Marketplace Version

INHERITED FROM

⇒

AVDMarketplaceVersion

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AzureId

String

Name

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Offer

INHERITED FROM

⇒

AVDOffer

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AzureId

String

Name

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels.ClientRulesPolicy.LocalDevicesAndResources

DESCRIPTION

Settings about the 'Multimedia Redirection for AVD' (Experimental)

INHERITED FROM

⇒

AVDMultimediaRedirection

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

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

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Types

NAMESPACE

RASAdminEngine.Core.OutputModels.Provider

DESCRIPTION

AVD Provider (Experimental)

INHERITED FROM

⇒

⇒

⇒

AVDProvider

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

AdminCreate

String

AdminLastMod

ADType

AD Type.

String

Description

Boolean

Enabled

String

FeedURL

The Feed URL.

String

GraphURL

The Graph URL.

UInt32

HostPort

UInt32

Id

Boolean

InheritDefaultAgentSettings

String

Name

UInt32

PreferredBrokerId

String

ProviderUsername

String

Server

UInt32

SiteId

DateTime

TimeCreate

DateTime

TimeLastMod

Type

String

VDIAgent

VDIAzureCloudInfo

VDI Azure Cloud Info.

UInt32

VDIPort

Version

Specifies the AVD Provider type version.

String

WebAccessURL

The Web Access URL.

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

GetHypervisorType ()

Type

GetType ()

Boolean

IsHWGPUSupported ()

String

ToString ()

References to Commands

NAMESPACE

RASAdminEngine.Core.OutputModels.AVD

DESCRIPTION

AVD Predefiend VM Images

INHERITED FROM

⇒

AVDPredefinedVMImage

INTERFACES

• ISerializable

• IComparable

PUBLIC PROPERTIES

Type

Name

Description

String

DisplayName

Image name

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

PUBLIC METHODS

Type

Name

Description

Int32

CompareTo (Object obj)

Boolean

Equals (Object obj)

Int32

GetHashCode ()

Type

GetType ()

String

ToString ()

References to Commands