Session Hosts - Get
Get a session host.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}?api-version=2022-02-10-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
host
|
path | True |
string |
The name of the host pool within the specified resource group |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
session
|
path | True |
string |
The name of the session host within the specified host pool |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved session host. |
|
Other Status Codes |
Automation error response describing why the operation failed. |
Examples
SessionHost_Get
Sample request
Sample response
{
"name": "sessionHost1.microsoft.com",
"id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com",
"type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts",
"systemData": {
"createdBy": "user1",
"createdByType": "User",
"createdAt": "2020-01-01T17:18:19.1234567Z",
"lastModifiedBy": "user2",
"lastModifiedByType": "User",
"lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
},
"properties": {
"objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
"lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
"sessions": 1,
"agentVersion": "1.0.0.1391",
"allowNewSession": true,
"assignedUser": "user1@microsoft.com",
"status": "Available",
"statusTimestamp": "2008-09-22T14:01:54.9571247Z",
"osVersion": "10.0.17763",
"sxSStackVersion": "rdp-sxs190816002",
"updateState": "Succeeded",
"lastUpdateTime": "2008-09-22T14:01:54.9571247Z",
"updateErrorMessage": "",
"virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef",
"friendlyName": "friendly",
"resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1",
"sessionHostHealthCheckResults": [
{
"healthCheckName": "DomainJoinedCheck",
"healthCheckResult": "HealthCheckSucceeded",
"additionalFailureDetails": {
"message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥",
"errorCode": 0,
"lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z"
}
}
]
}
}
Definitions
Name | Description |
---|---|
Cloud |
Cloud error object. |
Cloud |
Cloud error object properties. |
created |
The type of identity that created the resource. |
Health |
Represents the name of the health check operation performed. |
Health |
Represents the Health state of the health check we performed. |
Session |
Represents a SessionHost definition. |
Session |
Contains details on the failure. |
Session |
The report for session host information. |
Status |
Status for a SessionHost. |
system |
Metadata pertaining to creation and last modification of the resource. |
Update |
Update state of a SessionHost. |
CloudError
Cloud error object.
Name | Type | Description |
---|---|---|
error |
Cloud error object properties. |
CloudErrorProperties
Cloud error object properties.
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
HealthCheckName
Represents the name of the health check operation performed.
Name | Type | Description |
---|---|---|
AppAttachHealthCheck |
string |
Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. |
DomainJoinedCheck |
string |
Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. |
DomainReachable |
string |
Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. |
DomainTrustCheck |
string |
Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. |
FSLogixHealthCheck |
string |
Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. |
MetaDataServiceCheck |
string |
Verifies the metadata service is accessible and return compute properties. |
MonitoringAgentCheck |
string |
Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. |
SupportedEncryptionCheck |
string |
Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. |
SxSStackListenerCheck |
string |
Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. |
UrlsAccessibleCheck |
string |
Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). |
WebRTCRedirectorCheck |
string |
Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. |
HealthCheckResult
Represents the Health state of the health check we performed.
Name | Type | Description |
---|---|---|
HealthCheckFailed |
string |
Health check failed. |
HealthCheckSucceeded |
string |
Health check passed. |
SessionHostShutdown |
string |
We received a Shutdown notification. |
Unknown |
string |
Health check result is not currently known. |
SessionHost
Represents a SessionHost definition.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.agentVersion |
string |
Version of agent on SessionHost. |
properties.allowNewSession |
boolean |
Allow a new session. |
properties.assignedUser |
string |
User assigned to SessionHost. |
properties.friendlyName |
string |
Friendly name of SessionHost |
properties.lastHeartBeat |
string |
Last heart beat from SessionHost. |
properties.lastUpdateTime |
string |
The timestamp of the last update. |
properties.objectId |
string |
ObjectId of SessionHost. (internal use) |
properties.osVersion |
string |
The version of the OS on the session host. |
properties.resourceId |
string |
Resource Id of SessionHost's underlying virtual machine. |
properties.sessionHostHealthCheckResults |
List of SessionHostHealthCheckReports |
|
properties.sessions |
integer |
Number of sessions on SessionHost. |
properties.status |
Status for a SessionHost. |
|
properties.statusTimestamp |
string |
The timestamp of the status. |
properties.sxSStackVersion |
string |
The version of the side by side stack on the session host. |
properties.updateErrorMessage |
string |
The error message. |
properties.updateState |
Update state of a SessionHost. |
|
properties.virtualMachineId |
string |
Virtual Machine Id of SessionHost's underlying virtual machine. |
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
SessionHostHealthCheckFailureDetails
Contains details on the failure.
Name | Type | Description |
---|---|---|
errorCode |
integer |
Error code corresponding for the failure. |
lastHealthCheckDateTime |
string |
The timestamp of the last update. |
message |
string |
Failure message: hints on what is wrong and how to recover. |
SessionHostHealthCheckReport
The report for session host information.
Name | Type | Description |
---|---|---|
additionalFailureDetails |
Additional detailed information on the failure. |
|
healthCheckName |
Represents the name of the health check operation performed. |
|
healthCheckResult |
Represents the Health state of the health check we performed. |
Status
Status for a SessionHost.
Name | Type | Description |
---|---|---|
Available |
string |
Session Host has passed all the health checks and is available to handle connections. |
Disconnected |
string |
The Session Host is unavailable because it is currently disconnected. |
DomainTrustRelationshipLost |
string |
SessionHost's domain trust relationship lost |
FSLogixNotHealthy |
string |
FSLogix is in an unhealthy state on the session host. |
NeedsAssistance |
string |
New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal. |
NoHeartbeat |
string |
The Session Host is not heart beating. |
NotJoinedToDomain |
string |
SessionHost is not joined to domain. |
Shutdown |
string |
Session Host is shutdown - RD Agent reported session host to be stopped or deallocated. |
SxSStackListenerNotReady |
string |
SxS stack installed on the SessionHost is not ready to receive connections. |
Unavailable |
string |
Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status. |
UpgradeFailed |
string |
Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed. |
Upgrading |
string |
Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
UpdateState
Update state of a SessionHost.
Name | Type | Description |
---|---|---|
Failed |
string |
|
Initial |
string |
|
Pending |
string |
|
Started |
string |
|
Succeeded |
string |