Session

List AVD Host Sessions

Retrieve a list of Host Sessions by Site Id.

GET/api/Provider/VM/AVDHost/Session

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

hostIPnullable string

Host IP Address.

powerStateHostPowerState (enum)

Power State

0 = Unknown,1 = PoweringOn,2 = PoweredOn,4 = PoweringOff,8 = PoweredOff,16 = Suspending,32 = Suspended,64 = FailedToCreate,512 = Sysprep,1024 = Cloning,2048 = Deleting,4096 = Rasprep,4097 = Connected,4098 = Disconnected

assignmentHostAssignmentType (enum)

Host Assignment Type

1 = User,2 = Device

usernullable string

User.

disksnullable string

Disk(s).

avdAgentnullable string

AVD Agent name.

subnetNamenullable string

Subnet name.

sessionAVDRDPSession (object)

AVD user session

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/VM/AVDHost/Session', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": "text",
    "siteId": 0,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "agentVer": "text",
    "server": "text",
    "serverOS": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "unhandledExceptions": 0,
    "machineId": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "cpuLoad": 0,
    "memLoad": 0,
    "diskRead": 0,
    "diskWrite": 0,
    "enabled": false,
    "hostIP": "text",
    "powerState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweredOn",
      "4 = PoweringOff",
      "8 = PoweredOff",
      "16 = Suspending",
      "32 = Suspended",
      "64 = FailedToCreate",
      "512 = Sysprep",
      "1024 = Cloning",
      "2048 = Deleting",
      "4096 = Rasprep",
      "4097 = Connected",
      "4098 = Disconnected"
    ],
    "assignment": [
      "1 = User",
      "2 = Device"
    ],
    "user": "text",
    "disks": "text",
    "avdAgent": "text",
    "subnetName": "text",
    "session": {
      "sessionID": 0,
      "ip": "text",
      "serverID": 0,
      "type": [
        "0 = Desktop",
        "1 = PublishedApps",
        "2 = Application",
        "3 = VDI",
        "4 = VDIApp",
        "5 = PC",
        "6 = PCApp",
        "7 = Admin",
        "8 = Unknown",
        "9 = RemoteApps",
        "10 = DirectRDP",
        "-1 = All"
      ],
      "user": "text",
      "themeID": 0,
      "connectionMode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode",
        "4 = DirectRDPMode",
        "200 = Unknown"
      ],
      "authenticationType": [
        "0 = None",
        "1 = Credentials",
        "2 = SCard",
        "3 = SAML"
      ],
      "idleStartTime": "2024-12-21T13:43:26.760Z",
      "mfaProvider": [
        "0 = None",
        "1 = Deepnet",
        "2 = SafeNet",
        "3 = Radius",
        "4 = AzureRadius",
        "5 = DuoRadius",
        "6 = FortiRadius",
        "7 = TekRadius",
        "8 = GAuthTOTP",
        "9 = TOTP",
        "10 = MicrosoftTOTP",
        "11 = EmailOTP"
      ],
      "rfiCount": 0,
      "rfiInfoList": [
        {
          "type": [
            "0 = Unknown",
            "1 = HALBInst",
            "2 = Gateway",
            "3 = ForwardingGateway",
            "4 = HALBDevice",
            "5 = HTML5",
            "6 = Other",
            "7 = AVDGateway"
          ],
          "ip": "text"
        }
      ],
      "logonDuration": 0,
      "connectionDuration": 0,
      "authenticationDuration": 0,
      "rasPolicyLookup": 0,
      "hostPreparation": 0,
      "groupPolicyLoadTime": 0,
      "userProfileLoadTime": 0,
      "desktopLoadTime": 0,
      "logonOthersDuration": 0,
      "userProfileType": [
        "0 = Unknown",
        "1 = Others",
        "2 = UPD",
        "3 = FSLogix"
      ],
      "uxEvaluator": 0,
      "connectionQuality": [
        "0 = None",
        "1 = Poor",
        "2 = Fair",
        "3 = Good",
        "4 = Excellent"
      ],
      "latency": 0,
      "protocol": [
        "0 = Console",
        "2 = RDP",
        "10 = RDP_UDP"
      ],
      "bandwidthAvailability": 0,
      "lastReconnects": 0,
      "reconnects": 0,
      "disconnectReason": "text",
      "state": [
        "0 = Active",
        "1 = Connected",
        "2 = ConnectQuery",
        "3 = Shadow",
        "4 = Disconnected",
        "5 = Idle",
        "6 = Listen",
        "7 = Reset",
        "8 = Down",
        "9 = Init",
        "-1 = All"
      ],
      "logonTime": "2024-12-21T13:43:26.760Z",
      "sessionLength": 0,
      "idleTime": 0,
      "incomingData": 0,
      "outgoingData": 0,
      "verticalResolution": 0,
      "horizontalResolution": 0,
      "colourDepth": [
        "1 = COLOURDEPTH_4BIT",
        "2 = COLOURDEPTH_8BIT",
        "4 = COLOURDEPTH_16BIT",
        "8 = COLOURDEPTH_3BYTE",
        "16 = COLOURDEPTH_15BIT",
        "24 = COLOURDEPTH_24BIT",
        "32 = COLOURDEPTH_32BIT"
      ],
      "bandwidthUsage": 0,
      "deviceName": "text",
      "clientIPAddress": "text",
      "clientOS": "text",
      "clientOSVersion": "text",
      "clientVersion": "text",
      "hostId": "text"
    }
  }
]

List AVD Host Sessions by Provider Id

Retrieve a list of Host Sessions by Provider Id.

GET/api/Provider/{providerId}/VM/AVDHost/Session

Path parameters

providerId*integer (int32)

The Provider Id from which to retrieve the Hosts.

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

hostIPnullable string

Host IP Address.

powerStateHostPowerState (enum)

Power State

0 = Unknown,1 = PoweringOn,2 = PoweredOn,4 = PoweringOff,8 = PoweredOff,16 = Suspending,32 = Suspended,64 = FailedToCreate,512 = Sysprep,1024 = Cloning,2048 = Deleting,4096 = Rasprep,4097 = Connected,4098 = Disconnected

assignmentHostAssignmentType (enum)

Host Assignment Type

1 = User,2 = Device

usernullable string

User.

disksnullable string

Disk(s).

avdAgentnullable string

AVD Agent name.

subnetNamenullable string

Subnet name.

sessionAVDRDPSession (object)

AVD user session

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/AVDHost/Session', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": "text",
    "siteId": 0,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "agentVer": "text",
    "server": "text",
    "serverOS": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "unhandledExceptions": 0,
    "machineId": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "cpuLoad": 0,
    "memLoad": 0,
    "diskRead": 0,
    "diskWrite": 0,
    "enabled": false,
    "hostIP": "text",
    "powerState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweredOn",
      "4 = PoweringOff",
      "8 = PoweredOff",
      "16 = Suspending",
      "32 = Suspended",
      "64 = FailedToCreate",
      "512 = Sysprep",
      "1024 = Cloning",
      "2048 = Deleting",
      "4096 = Rasprep",
      "4097 = Connected",
      "4098 = Disconnected"
    ],
    "assignment": [
      "1 = User",
      "2 = Device"
    ],
    "user": "text",
    "disks": "text",
    "avdAgent": "text",
    "subnetName": "text",
    "session": {
      "sessionID": 0,
      "ip": "text",
      "serverID": 0,
      "type": [
        "0 = Desktop",
        "1 = PublishedApps",
        "2 = Application",
        "3 = VDI",
        "4 = VDIApp",
        "5 = PC",
        "6 = PCApp",
        "7 = Admin",
        "8 = Unknown",
        "9 = RemoteApps",
        "10 = DirectRDP",
        "-1 = All"
      ],
      "user": "text",
      "themeID": 0,
      "connectionMode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode",
        "4 = DirectRDPMode",
        "200 = Unknown"
      ],
      "authenticationType": [
        "0 = None",
        "1 = Credentials",
        "2 = SCard",
        "3 = SAML"
      ],
      "idleStartTime": "2024-12-21T13:43:26.760Z",
      "mfaProvider": [
        "0 = None",
        "1 = Deepnet",
        "2 = SafeNet",
        "3 = Radius",
        "4 = AzureRadius",
        "5 = DuoRadius",
        "6 = FortiRadius",
        "7 = TekRadius",
        "8 = GAuthTOTP",
        "9 = TOTP",
        "10 = MicrosoftTOTP",
        "11 = EmailOTP"
      ],
      "rfiCount": 0,
      "rfiInfoList": [
        {
          "type": [
            "0 = Unknown",
            "1 = HALBInst",
            "2 = Gateway",
            "3 = ForwardingGateway",
            "4 = HALBDevice",
            "5 = HTML5",
            "6 = Other",
            "7 = AVDGateway"
          ],
          "ip": "text"
        }
      ],
      "logonDuration": 0,
      "connectionDuration": 0,
      "authenticationDuration": 0,
      "rasPolicyLookup": 0,
      "hostPreparation": 0,
      "groupPolicyLoadTime": 0,
      "userProfileLoadTime": 0,
      "desktopLoadTime": 0,
      "logonOthersDuration": 0,
      "userProfileType": [
        "0 = Unknown",
        "1 = Others",
        "2 = UPD",
        "3 = FSLogix"
      ],
      "uxEvaluator": 0,
      "connectionQuality": [
        "0 = None",
        "1 = Poor",
        "2 = Fair",
        "3 = Good",
        "4 = Excellent"
      ],
      "latency": 0,
      "protocol": [
        "0 = Console",
        "2 = RDP",
        "10 = RDP_UDP"
      ],
      "bandwidthAvailability": 0,
      "lastReconnects": 0,
      "reconnects": 0,
      "disconnectReason": "text",
      "state": [
        "0 = Active",
        "1 = Connected",
        "2 = ConnectQuery",
        "3 = Shadow",
        "4 = Disconnected",
        "5 = Idle",
        "6 = Listen",
        "7 = Reset",
        "8 = Down",
        "9 = Init",
        "-1 = All"
      ],
      "logonTime": "2024-12-21T13:43:26.760Z",
      "sessionLength": 0,
      "idleTime": 0,
      "incomingData": 0,
      "outgoingData": 0,
      "verticalResolution": 0,
      "horizontalResolution": 0,
      "colourDepth": [
        "1 = COLOURDEPTH_4BIT",
        "2 = COLOURDEPTH_8BIT",
        "4 = COLOURDEPTH_16BIT",
        "8 = COLOURDEPTH_3BYTE",
        "16 = COLOURDEPTH_15BIT",
        "24 = COLOURDEPTH_24BIT",
        "32 = COLOURDEPTH_32BIT"
      ],
      "bandwidthUsage": 0,
      "deviceName": "text",
      "clientIPAddress": "text",
      "clientOS": "text",
      "clientOSVersion": "text",
      "clientVersion": "text",
      "hostId": "text"
    }
  }
]

Get AVD Host Session

Retrieve the Host Sessions.

GET/api/Provider/{providerId}/VM/{id}/AVDHost/Session

Path parameters

providerId*integer (int32)

The Provider Id from which to retrieve the Hosts.

id*string

The ID of the Host for which to retrieve the status.

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

hostIPnullable string

Host IP Address.

powerStateHostPowerState (enum)

Power State

0 = Unknown,1 = PoweringOn,2 = PoweredOn,4 = PoweringOff,8 = PoweredOff,16 = Suspending,32 = Suspended,64 = FailedToCreate,512 = Sysprep,1024 = Cloning,2048 = Deleting,4096 = Rasprep,4097 = Connected,4098 = Disconnected

assignmentHostAssignmentType (enum)

Host Assignment Type

1 = User,2 = Device

usernullable string

User.

disksnullable string

Disk(s).

avdAgentnullable string

AVD Agent name.

subnetNamenullable string

Subnet name.

sessionAVDRDPSession (object)

AVD user session

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{id}/AVDHost/Session', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "id": "text",
  "siteId": 0,
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "agentVer": "text",
  "server": "text",
  "serverOS": "text",
  "serviceStartTime": "text",
  "systemBootTime": "text",
  "unhandledExceptions": 0,
  "machineId": "text",
  "logLevel": [
    "0 = Critical",
    "1 = Error",
    "2 = Warning",
    "3 = Standard",
    "4 = Extended",
    "5 = Verbose",
    "-1 = None"
  ],
  "cpuLoad": 0,
  "memLoad": 0,
  "diskRead": 0,
  "diskWrite": 0,
  "enabled": false,
  "hostIP": "text",
  "powerState": [
    "0 = Unknown",
    "1 = PoweringOn",
    "2 = PoweredOn",
    "4 = PoweringOff",
    "8 = PoweredOff",
    "16 = Suspending",
    "32 = Suspended",
    "64 = FailedToCreate",
    "512 = Sysprep",
    "1024 = Cloning",
    "2048 = Deleting",
    "4096 = Rasprep",
    "4097 = Connected",
    "4098 = Disconnected"
  ],
  "assignment": [
    "1 = User",
    "2 = Device"
  ],
  "user": "text",
  "disks": "text",
  "avdAgent": "text",
  "subnetName": "text",
  "session": {
    "sessionID": 0,
    "ip": "text",
    "serverID": 0,
    "type": [
      "0 = Desktop",
      "1 = PublishedApps",
      "2 = Application",
      "3 = VDI",
      "4 = VDIApp",
      "5 = PC",
      "6 = PCApp",
      "7 = Admin",
      "8 = Unknown",
      "9 = RemoteApps",
      "10 = DirectRDP",
      "-1 = All"
    ],
    "user": "text",
    "themeID": 0,
    "connectionMode": [
      "0 = GatewayMode",
      "1 = DirectMode",
      "2 = GatewaySSLMode",
      "3 = DirectSSLMode",
      "4 = DirectRDPMode",
      "200 = Unknown"
    ],
    "authenticationType": [
      "0 = None",
      "1 = Credentials",
      "2 = SCard",
      "3 = SAML"
    ],
    "idleStartTime": "2024-12-21T13:43:26.760Z",
    "mfaProvider": [
      "0 = None",
      "1 = Deepnet",
      "2 = SafeNet",
      "3 = Radius",
      "4 = AzureRadius",
      "5 = DuoRadius",
      "6 = FortiRadius",
      "7 = TekRadius",
      "8 = GAuthTOTP",
      "9 = TOTP",
      "10 = MicrosoftTOTP",
      "11 = EmailOTP"
    ],
    "rfiCount": 0,
    "rfiInfoList": [
      {
        "type": [
          "0 = Unknown",
          "1 = HALBInst",
          "2 = Gateway",
          "3 = ForwardingGateway",
          "4 = HALBDevice",
          "5 = HTML5",
          "6 = Other",
          "7 = AVDGateway"
        ],
        "ip": "text"
      }
    ],
    "logonDuration": 0,
    "connectionDuration": 0,
    "authenticationDuration": 0,
    "rasPolicyLookup": 0,
    "hostPreparation": 0,
    "groupPolicyLoadTime": 0,
    "userProfileLoadTime": 0,
    "desktopLoadTime": 0,
    "logonOthersDuration": 0,
    "userProfileType": [
      "0 = Unknown",
      "1 = Others",
      "2 = UPD",
      "3 = FSLogix"
    ],
    "uxEvaluator": 0,
    "connectionQuality": [
      "0 = None",
      "1 = Poor",
      "2 = Fair",
      "3 = Good",
      "4 = Excellent"
    ],
    "latency": 0,
    "protocol": [
      "0 = Console",
      "2 = RDP",
      "10 = RDP_UDP"
    ],
    "bandwidthAvailability": 0,
    "lastReconnects": 0,
    "reconnects": 0,
    "disconnectReason": "text",
    "state": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ],
    "logonTime": "2024-12-21T13:43:26.760Z",
    "sessionLength": 0,
    "idleTime": 0,
    "incomingData": 0,
    "outgoingData": 0,
    "verticalResolution": 0,
    "horizontalResolution": 0,
    "colourDepth": [
      "1 = COLOURDEPTH_4BIT",
      "2 = COLOURDEPTH_8BIT",
      "4 = COLOURDEPTH_16BIT",
      "8 = COLOURDEPTH_3BYTE",
      "16 = COLOURDEPTH_15BIT",
      "24 = COLOURDEPTH_24BIT",
      "32 = COLOURDEPTH_32BIT"
    ],
    "bandwidthUsage": 0,
    "deviceName": "text",
    "clientIPAddress": "text",
    "clientOS": "text",
    "clientOSVersion": "text",
    "clientVersion": "text",
    "hostId": "text"
  }
}