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 參數

名稱	位於	必要	類型	Description
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)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
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"
        }
      }
    ]
  }
}

定義

名稱	Description
CloudError	雲端錯誤物件。
CloudErrorProperties	雲端錯誤物件屬性。
createdByType	建立資源的身分識別類型。
HealthCheckName	代表所執行運作狀態檢查作業的名稱。
HealthCheckResult	代表我們執行的運作狀態檢查的運作狀態。
SessionHost	代表 SessionHost 定義。
SessionHostHealthCheckFailureDetails	包含失敗的詳細資料。
SessionHostHealthCheckReport	工作階段主機資訊的報告。
Status	SessionHost 的狀態。
systemData	與建立和上次修改資源相關的元數據。
UpdateState	更新 SessionHost 的狀態。

CloudError

Object

雲端錯誤物件。

名稱	類型	Description
error	CloudErrorProperties	雲端錯誤物件屬性。

CloudErrorProperties

Object

雲端錯誤物件屬性。

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

HealthCheckName

列舉型別

代表所執行運作狀態檢查作業的名稱。

值	Description
DomainJoinedCheck	確認 SessionHost 已加入網域。如果此檢查失敗，則會分類為致命，因為如果 SessionHost 未加入網域，則無法成功連線。（目前已啟用）
DomainTrustCheck	確認 SessionHost 沒有遇到網域信任問題，這些問題會阻止在建立工作階段時在連線時對 SessionHost 進行驗證。如果此檢查失敗，則會歸類為致命，因為如果我們無法連線到SessionHost上的域進行身份驗證，則無法成功連線。（目前已啟用）
FSLogixHealthCheck	確認 FSLogix 服務已啟動並執行，以確保使用者的配置檔已載入會話中。如果此檢查失敗，則會歸類為致命，因為即使連線可以成功，使用者體驗也會很差，因為無法載入使用者設定檔，而且使用者將在工作階段中取得暫時設定檔。（目前已停用）
SxSStackListenerCheck	驗證 SxS 堆疊是否已啟動並執行，以便連線成功。如果此檢查失敗，則被歸類為致命，因為如果SxS堆疊未就緒，則無法成功連線。（目前已啟用）
UrlsAccessibleCheck	驗證是否可從 SessionHost 連線到所需的 WVD 服務和 Geneva URL。這些 URL 是：RdTokenUri、RdBrokerURI、RdDiagnosticsUri 和用於代理程式監視的儲存體 Blob URL （geneva）。如果此檢查失敗，則非致命且機器仍可為連線提供服務，主要問題可能是監視代理程式無法儲存暖路徑資料（記錄、作業...）。（目前已停用）
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

列舉型別

代表我們執行的運作狀態檢查的運作狀態。

值	Description
Unknown	目前未知性能檢查結果。
HealthCheckSucceeded	健康情況檢查通過。
HealthCheckFailed	運作狀態檢查失敗。
SessionHostShutdown	我們收到關機通知。

SessionHost

Object

代表 SessionHost 定義。

名稱	類型	Description
id	string (arm-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 基礎虛擬機器的資源識別碼。
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 基礎虛擬機器的虛擬機器識別碼。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SessionHostHealthCheckFailureDetails

Object

包含失敗的詳細資料。

名稱	類型	Description
errorCode	integer (int32)	對應於失敗的錯誤碼。
lastHealthCheckDateTime	string (date-time)	上次更新的時間戳記。
message	string	失敗訊息：提示問題所在以及如何恢復。

SessionHostHealthCheckReport

Object

工作階段主機資訊的報告。

名稱	類型	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	有關失敗的其他詳細資訊。
healthCheckName	HealthCheckName	代表所執行運作狀態檢查作業的名稱。
healthCheckResult	HealthCheckResult	代表我們執行的運作狀態檢查的運作狀態。

Status

列舉型別

SessionHost 的狀態。

值	Description
Available	工作階段主機已通過所有性能檢查，可用於處理連線。
Unavailable	工作階段主機已關閉或未通過重要性能檢查，導致服務無法將連線路由至此工作階段主機。請注意，這會取代先前的「NoHeartBeat」狀態。
Shutdown	會話主機已關閉 - RD 代理程式報告會話主機已停止或解除配置。
Disconnected	工作階段主機無法使用，因為它目前已中斷連線。
Upgrading	工作階段主機無法使用，因為目前正在升級 RDAgent/並存堆疊。注意：一旦升級完成且主機能夠接受連線，此狀態將被刪除。
UpgradeFailed	工作階段主機無法使用，因為關鍵元件升級（代理程式、並存堆疊等）失敗。
NoHeartbeat	工作階段主機沒有心跳。
NotJoinedToDomain	SessionHost 未加入網域。
DomainTrustRelationshipLost	SessionHost 的網域信任關係遺失
SxSStackListenerNotReady	安裝在 SessionHost 上的 SxS 堆疊尚未準備好接收連線。
FSLogixNotHealthy	FSLogix 在會話主機上處於狀況不良狀態。
NeedsAssistance	新狀態，以通知系統管理員其端點上的健康情況需要修正。連線可能不會失敗，因為這些問題不是致命的。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UpdateState

列舉型別

更新 SessionHost 的狀態。

值	Description
Initial
Pending
Started
Succeeded
Failed

共用方式為

Session Hosts - Get

URI 參數

回應

範例

SessionHost_Get

範例要求

範例回覆

定義

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState