Session Hosts - Get

セッション ホストを取得します。

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

URI パラメーター

Name In Required Type Description
hostPoolName
path True
  • string

指定したリソース グループ内のホスト プールの名前

resourceGroupName
path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。

sessionHostName
path True
  • string

指定したホスト プール内のセッション ホストの名前

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

セッション ホストが正常に取得されました。

Other Status Codes

操作が失敗した理由を説明するオートメーション エラー応答。

SessionHost_Get

Sample Request

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

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",
  "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",
    "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
HealthCheckName

実行された正常性チェック操作の名前を表します。

HealthCheckResult

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

SessionHost

SessionHost 定義を表します。

SessionHostHealthCheckFailureDetails

エラーの詳細が含まれている。

SessionHostHealthCheckReport

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

Status

SessionHost の状態。

UpdateState

SessionHost の状態を更新します。

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

エラー コード

message
  • string

操作が失敗した理由を示すエラー メッセージ。

HealthCheckName

実行された正常性チェック操作の名前を表します。

Name Type Description
AppAttachHealthCheck
  • string

AppAttachService が正常な状態 (パッケージのステージング中に問題が発生していなか) を確認します。 AppAttachService は、テナント管理者によって設定された MSIX アプリのステージング/登録 (および最終的な登録解除/デタグ付け) を有効にするために使用されます。これにより、パッケージのステージング中にコンポーネントにエラーが発生したかどうかが確認されます。 ステージングでエラーが発生すると、一部の MSIX アプリがエンド ユーザーに対して正常に動作しなくなになります。 このチェックが失敗した場合、それは致命的ではなく、マシンは接続を引き続き処理できます。主な問題は、エンド ユーザーに対して特定のアプリが機能しない可能性があります。

DomainJoinedCheck
  • string

SessionHost がドメインに参加状態を確認します。 このチェックが失敗した場合、SessionHost がドメインに参加していない場合、接続は成功しないので、致命的として分類されます。

DomainReachable
  • string

SessionHost が参加しているドメインにまだ到達可能な状態を確認します。 このチェックが失敗した場合、接続時に SessionHost が参加しているドメインに到達できない場合、接続は成功しないので、致命的として分類されます。

DomainTrustCheck
  • string

セッションの作成時に SessionHost での認証を妨げるドメイン信頼の問題が SessionHost で発生していないことを確認します。 このチェックが失敗した場合、SessionHost で認証のためにドメインに到達できない場合、接続は成功しないので、致命的として分類されます。

FSLogixHealthCheck
  • string

FSLogix サービスが稼働中であり、ユーザーのプロファイルがセッションに読み込まれるか確認します。 このチェックが失敗した場合は、接続が成功する可能性がある場合でも致命的として分類されます。ユーザー プロファイルを読み込めなかったり、ユーザーがセッションで一時的なプロファイルを取得する可能性があります。

MetaDataServiceCheck
  • string

メタデータ サービスにアクセス可能であり、コンピューティング プロパティが返されるのを確認します。

MonitoringAgentCheck
  • string

必要な Geneva エージェントが実行されている状態を確認します。 このチェックが失敗した場合、それは致命的でなく、マシンは引き続き接続を処理できます。主な問題は、監視エージェントが見つからないか、古いバージョンが実行されている可能性があります。

SupportedEncryptionCheck
  • string

SecurityLayer 登録キーの値を確認します。 値が 0 (SecurityLayer.RDP) の場合、このチェックはエラー コード = NativeMethodErrorCode.E_FAILで失敗し、致命的です。 値が 1 (SecurityLayer.Negotiate) の場合、このチェックはエラー コード = NativeMethodErrorCode.ERROR_SUCCESSで失敗し、致命的ではありません。

SxSStackListenerCheck
  • string

SxS スタックが稼働し、接続が成功可能な状態を確認します。 このチェックが失敗した場合は、SxS スタックの準備ができていない場合に接続が成功しなく、致命的として分類されます。

UrlsAccessibleCheck
  • string

必要な WVD サービスとジュネーブ URL に SessionHost から到達可能な状態を確認します。 これらの URL は、RdTokenUri、RdBrokerURI、RdDiagnosticsUri、およびエージェント監視用のストレージ BLOB URL (geneva) です。 このチェックが失敗した場合、それは致命的で、マシンは接続を引き続き処理できます。主な問題は、監視エージェントがウォーム パス データ (ログ、操作 ...) を格納できない可能性があります。

WebRTCRedirectorCheck
  • string

WebRTCRedirector コンポーネントが正常かどうかを確認します。 WebRTCRedirector コンポーネントは、ビデオとオーディオのパフォーマンスを最適化するために使用Microsoft Teams。 これにより、コンポーネントがまだ実行されているかどうかを確認し、より高いバージョンを使用できるかどうかを確認します。 このチェックが失敗した場合、それは致命的な問題であり、マシンは接続を引き続き処理できます。主な問題は、WebRTCRedirector コンポーネントを再起動または更新する必要がある可能性があります。

HealthCheckResult

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

Name Type Description
HealthCheckFailed
  • string

正常性チェックに失敗しました。

HealthCheckSucceeded
  • string

正常性チェックに合格しました。

SessionHostShutdown
  • string

シャットダウン通知を受信しました。

Unknown
  • string

正常性チェックの結果は現在不明です。

SessionHost

SessionHost 定義を表します。

Name Type Description
id
  • string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

リソースの名前

properties.agentVersion
  • string

SessionHost 上のエージェントのバージョン。

properties.allowNewSession
  • boolean

新しいセッションを許可します。

properties.assignedUser
  • string

SessionHost に割り当てられたユーザー。

properties.lastHeartBeat
  • string

SessionHost からの最後の心の動き。

properties.lastUpdateTime
  • string

最後の更新のタイムスタンプ。

properties.objectId
  • string

SessionHost の ObjectId。 (内部使用)

properties.osVersion
  • string

セッション ホスト上の OS のバージョン。

properties.resourceId
  • string

SessionHost の基になる仮想マシンのリソース ID。

properties.sessionHostHealthCheckResults

SessionHostHealthCheckReports の一覧

properties.sessions
  • integer

SessionHost 上のセッションの数。

properties.status

SessionHost の状態。

properties.statusTimestamp
  • string

状態のタイムスタンプ。

properties.sxSStackVersion
  • string

セッション ホスト上のサイド バイ サイド スタックのバージョン。

properties.updateErrorMessage
  • string

エラー メッセージ。

properties.updateState

SessionHost の状態を更新します。

properties.virtualMachineId
  • string

SessionHost の基になる仮想マシンの仮想マシン ID。

type
  • string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft。Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

エラーの詳細が含まれている。

Name Type Description
errorCode
  • integer

エラーに対応するエラー コード。

lastHealthCheckDateTime
  • string

最後の更新のタイムスタンプ。

message
  • string

エラー メッセージ: 問題の原因と復旧方法を示すヒント。

SessionHostHealthCheckReport

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

Name Type Description
additionalFailureDetails

エラーに関する追加情報。

healthCheckName

実行された正常性チェック操作の名前を表します。

healthCheckResult

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

Status

SessionHost の状態。

Name Type Description
Available
  • string

セッション ホストは、すべての正常性チェックに合格し、接続を処理するために使用できます。

Disconnected
  • string

セッション ホストは現在切断されています。

DomainTrustRelationshipLost
  • string

SessionHost のドメインの信頼関係が失われた

FSLogixNotHealthy
  • string

FSLogix は、セッション ホスト上で問題の状態です。

NeedsAssistance
  • string

エンドポイントの正常性を修正する必要がある場合に管理者に通知する新しい状態。 これらの問題は致命的ではなさいので、接続が失敗しない可能性があります。

NoHeartbeat
  • string

セッション ホストは、心を打ち負かしているのではありません。

NotJoinedToDomain
  • string

SessionHost がドメインに参加していない。

Shutdown
  • string

セッション ホストがシャットダウンされました - RD エージェントによって、セッション ホストが停止またはデロケーションが報告されました。

SxSStackListenerNotReady
  • string

SessionHost にインストールされている SxS スタックは、接続を受信する準備ができていません。

Unavailable
  • string

セッション ホストがオフになっているか、重大な正常性チェックに失敗した場合、サービスはこのセッション ホストに接続をルーティングできません。 これにより、以前の 'NoHeartBeat' 状態が置き換わる点に注意してください。

UpgradeFailed
  • string

重要なコンポーネントのアップグレード (エージェント、サイド バイ サイド スタックなど) が失敗したため、セッション ホストは使用できません。

Upgrading
  • string

現在、RDAgent/side-by-side スタックのアップグレードが進行中のため、セッション ホストは使用できません。 注: アップグレードが完了し、ホストが接続を受け入れられると、この状態は削除されます。

UpdateState

SessionHost の状態を更新します。

Name Type Description
Failed
  • string
Initial
  • string
Pending
  • string
Started
  • string
Succeeded
  • string