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	リソースを作成した ID の種類。
HealthCheckName	実行されたヘルスチェック操作の名前を表します。
HealthCheckResult	実行したヘルスチェックの正常性状態を表します。
SessionHost	SessionHost 定義を表します。
SessionHostHealthCheckFailureDetails	エラーの詳細が含まれます。
SessionHostHealthCheckReport	セッションホスト情報のレポート。
Status	SessionHost のステータス。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UpdateState	SessionHost の状態を更新します。

CloudError

Object

クラウドエラーオブジェクト。

名前	型	説明
error	CloudErrorProperties	クラウドエラーオブジェクトのプロパティ。

CloudErrorProperties

Object

クラウドエラーオブジェクトのプロパティ。

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

HealthCheckName

列挙

実行されたヘルスチェック操作の名前を表します。

値	説明
DomainJoinedCheck	SessionHost がドメインに参加していることを確認します。このチェックが失敗した場合、SessionHost がドメインに参加していない場合は接続が成功しないため、致命的として分類されます。 (現在有効)
DomainTrustCheck	セッションの作成時に接続時に SessionHost での認証を妨げるドメイン信頼の問題が SessionHost に発生していないことを確認します。このチェックが失敗した場合、SessionHost で認証のためにドメインに到達できない場合、接続が成功しないため、致命的として分類されます。 (現在有効)
FSLogixHealthCheck	FSLogix サービスが稼働していることを確認し、ユーザーのプロファイルがセッションに読み込まれていることを確認します。このチェックが失敗した場合、接続が成功できたとしても、ユーザープロファイルを読み込めず、ユーザーがセッションで一時的なプロファイルを取得するため、ユーザーエクスペリエンスが悪くなるため、致命的なものとして分類されます。 (現在は無効)
SxSStackListenerCheck	接続が成功できるように、SxS スタックが稼働していることを確認します。このチェックが失敗した場合、SxS スタックの準備ができていない場合、接続を成功させることができないため、致命的として分類されます。 (現在有効)
UrlsAccessibleCheck	必要な WVD サービスと Geneva URL が SessionHost から到達可能であることを確認します。これらの 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

列挙

実行したヘルスチェックの正常性状態を表します。

値	説明
Unknown	ヘルスチェックの結果は、現在不明です。
HealthCheckSucceeded	ヘルスチェックに合格しました。
HealthCheckFailed	ヘルスチェックに失敗しました。
SessionHostShutdown	シャットダウン通知を受け取りました。

SessionHost

Object

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	セッションホスト上の OS のバージョン。
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

Object

エラーの詳細が含まれます。

名前	型	説明
errorCode	integer (int32)	エラーに対応するエラーコード。
lastHealthCheckDateTime	string (date-time)	最終更新のタイムスタンプ。
message	string	失敗メッセージ: 何が問題なのか、どのように回復できるのかを示すヒント。

SessionHostHealthCheckReport

Object

セッションホスト情報のレポート。

名前	型	説明
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

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UpdateState

列挙

SessionHost の状態を更新します。

値	説明
Initial
Pending
Started
Succeeded
Failed

次の方法で共有

Session Hosts - Get

URI パラメーター

応答

例

SessionHost_Get

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState