Session Hosts - Get

服务:

Desktop Virtualization

API 版本:

2025-10-10

获取会话主机。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}?api-version=2025-10-10

URI 参数

名称	在	必需	类型	说明
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	指定资源组中主机池的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	指定主机池中会话主机的名称
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	SessionHost	成功检索到会话主机。
Other Status Codes	CloudError	描述作失败原因的自动化错误响应。

示例

SessionHost_Get

示例请求

HTTP

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com?api-version=2025-10-10

示例响应

状态代码:

200

{
  "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"
        }
      }
    ]
  }
}

定义

名称	说明
CloudError	云端错误对象。
CloudErrorProperties	云错误对象属性。
createdByType	创建资源的标识的类型。
HealthCheckName	表示执行的运行状况检查作的名称。
HealthCheckResult	表示我们执行的运行状况检查的运行状况状态。
SessionHost	表示 SessionHost 定义。
SessionHostHealthCheckFailureDetails	包含有关失败的详细信息。
SessionHostHealthCheckReport	会话主机信息的报告。
Status	SessionHost 的状态。
systemData	与创建和上次修改资源相关的元数据。
UpdateState	更新 SessionHost 的状态。

CloudError

对象

云端错误对象。

名称	类型	说明
error	CloudErrorProperties	云错误对象属性。

CloudErrorProperties

对象

云错误对象属性。

名称	类型	说明
code	string	错误代码
message	string	指示操作失败的原因的错误消息。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

HealthCheckName

枚举

表示执行的运行状况检查作的名称。

值	说明
DomainJoinedCheck	验证 SessionHost 是否已加入域。 如果此检查失败，则被归类为致命检查，因为如果 SessionHost 未加入域，则无法成功连接。 （当前启用）
DomainTrustCheck	验证 SessionHost 是否遇到域信任问题，这些问题会阻止在创建会话时连接时对 SessionHost 进行身份验证。 如果此检查失败，则被归类为致命，因为如果我们无法访问 SessionHost 上的域进行身份验证，则无法成功连接。 （当前启用）
FSLogixHealthCheck	验证 FSLogix 服务是否已启动并正在运行，以确保在会话中加载用户的配置文件。 如果此检查失败，则被归类为致命检查，因为即使连接可以成功，用户体验也会很差，因为无法加载用户配置文件，并且用户将在会话中获得临时配置文件。 （目前禁用）
SxSStackListenerCheck	验证 SxS 堆栈是否已启动并正在运行，以便连接成功。 如果此检查失败，则被归类为致命，因为如果 SxS 堆栈未就绪，则无法成功连接。 （当前启用）
UrlsAccessibleCheck	验证是否可以从 SessionHost 访问所需的 WVD 服务和 Geneva URL。 这些 URL 是：RdTokenUri、RdBrokerURI、RdDiagnosticsUri 和用于代理监视的存储 blob URL（日内瓦）。 如果此检查失败，则非致命检查，并且计算机仍然可以为连接提供服务，主要问题可能是监控代理无法存储暖路径数据（日志、作等）。（目前禁用）
MonitoringAgentCheck	验证所需的 Geneva 代理是否正在运行。 如果此检查失败，则它不是致命的，并且计算机仍然可以为连接提供服务，主要问题可能是监视代理丢失或正在运行（可能）旧版本。 （当前启用）
DomainReachable	验证 SessionHost 加入的域是否仍可访问。 如果此检查失败，则被归类为致命，因为如果连接时无法访问 SessionHost 加入的域，则无法成功连接。 （目前禁用）
WebRTCRedirectorCheck	验证 WebRTCRedirector 组件是否正常。 WebRTCRedirector 组件用于优化 Microsoft Teams 中的视频和音频性能。 这将检查组件是否仍在运行，以及是否有更高的版本可用。 如果此检查失败，则非致命检查，并且机器仍然可以为连接提供服务，主要问题可能是必须重新启动或更新 WebRTCRedirector 组件。 （目前禁用）
SupportedEncryptionCheck	验证 SecurityLayer 注册密钥的值。 如果值为 0 （SecurityLayer.RDP），则此检查将失败，错误代码 = NativeMethodErrorCode.E_FAIL，并且是致命的。 如果值为 1 （SecurityLayer.Negotiate） ，则此检查将失败，错误代码 = NativeMethodErrorCode.ERROR_SUCCESS，并且不是致命的。 （目前禁用）
MetaDataServiceCheck	验证元数据服务是否可访问并返回计算属性。 （当前启用）
AppAttachHealthCheck	验证 AppAttachService 是否正常（包暂存期间没有问题）。 AppAttachService用于启用租户管理员设置的MSIX应用的临时/注册（以及最终注销/销毁）。这会检查组件在包准备过程中是否出现故障。 暂存失败将阻止某些 MSIX 应用为最终用户正常工作。 如果此检查失败，则不是致命的，并且机器仍然可以为连接提供服务，主要问题可能是某些应用程序对最终用户不起作用。 （当前启用）

HealthCheckResult

枚举

表示我们执行的运行状况检查的运行状况状态。

值	说明
Unknown	健康检查结果目前未知。
HealthCheckSucceeded	运行状况检查通过。
HealthCheckFailed	运行状况检查失败。
SessionHostShutdown	我们收到了关闭通知。

SessionHost

对象

表示 SessionHost 定义。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.agentVersion	string	SessionHost 上的代理版本。
properties.allowNewSession	boolean	允许新会话。
properties.assignedUser	string	分配给 SessionHost 的用户。
properties.friendlyName	string	SessionHost 的友好名称
properties.lastHeartBeat	string (date-time)	来自 SessionHost 的最后一次心跳。
properties.lastUpdateTime	string (date-time)	上次更新的时间戳。
properties.objectId	string	SessionHost 的 ObjectId。 （内部使用）
properties.osVersion	string	会话主机上的作系统版本。
properties.resourceId	string	SessionHost 基础虚拟机的资源 ID。
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	SessionHostHealthCheckReports 列表
properties.sessions	integer (int32)	SessionHost 上的会话数。
properties.status	Status	SessionHost 的状态。
properties.statusTimestamp	string (date-time)	状态的时间戳。
properties.sxSStackVersion	string	会话主机上并行堆栈的版本。
properties.updateErrorMessage	string	错误消息。
properties.updateState	UpdateState	更新 SessionHost 的状态。
properties.virtualMachineId	string	SessionHost 底层虚拟机的虚拟机 ID。
systemData	systemData	与创建和上次修改资源相关的元数据。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SessionHostHealthCheckFailureDetails

对象

包含有关失败的详细信息。

名称	类型	说明
errorCode	integer (int32)	与失败对应的错误代码。
lastHealthCheckDateTime	string (date-time)	上次更新的时间戳。
message	string	失败消息：提示问题所在以及如何恢复。

SessionHostHealthCheckReport

对象

会话主机信息的报告。

名称	类型	说明
additionalFailureDetails	SessionHostHealthCheckFailureDetails	有关故障的其他详细信息。
healthCheckName	HealthCheckName	表示执行的运行状况检查作的名称。
healthCheckResult	HealthCheckResult	表示我们执行的运行状况检查的运行状况状态。

Status

枚举

SessionHost 的状态。

值	说明
Available	会话主机已通过所有运行状况检查，可用于处理连接。
Unavailable	会话主机已关闭或未通过关键运行状况检查，这导致服务无法将连接路由到此会话主机。 请注意，这将替换以前的“NoHeartBeat”状态。
Shutdown	会话主机已关闭 - RD 代理报告要停止或取消分配会话主机。
Disconnected	会话主机不可用，因为它当前已断开连接。
Upgrading	会话主机不可用，因为当前正在升级 RDAgent/并行堆栈。 注意：一旦升级完成并且主机能够接受连接，此状态将被删除。
UpgradeFailed	会话主机不可用，因为关键组件升级（代理、并行堆栈等）失败。
NoHeartbeat	会话主机未心脏跳动。
NotJoinedToDomain	SessionHost 未加入域。
DomainTrustRelationshipLost	SessionHost 的域信任关系丢失
SxSStackListenerNotReady	安装在 SessionHost 上的 SxS 堆栈尚未准备好接收连接。
FSLogixNotHealthy	FSLogix 在会话主机上处于不正常状态。
NeedsAssistance	新状态，通知管理员需要修复其终结点上的运行状况。 连接可能不会失败，因为这些问题不是致命的。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UpdateState

枚举

更新 SessionHost 的状态。

值	说明
Initial
Pending
Started
Succeeded
Failed