Session Hosts - Get

Layanan:: Desktop Virtualization

Versi API:: 2025-10-10

Dapatkan host sesi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nama kumpulan host dalam grup sumber daya yang ditentukan
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nama host sesi dalam kumpulan host yang ditentukan
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	SessionHost	Berhasil mengambil host sesi.
Other Status Codes	CloudError	Respons kesalahan otomatisasi yang menjelaskan mengapa operasi gagal.

Contoh

SessionHost_Get

Permintaan sampel

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

Respon sampel

Kode status:: 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"
        }
      }
    ]
  }
}

Definisi

Nama	Deskripsi
CloudError	Objek kesalahan cloud.
CloudErrorProperties	Properti objek kesalahan cloud.
createdByType	Jenis identitas yang membuat sumber daya.
HealthCheckName	Mewakili nama operasi pemeriksaan kondisi yang dilakukan.
HealthCheckResult	Mewakili status Kesehatan pemeriksaan kesehatan yang kami lakukan.
SessionHost	Mewakili definisi SessionHost.
SessionHostHealthCheckFailureDetails	Berisi detail tentang kegagalan.
SessionHostHealthCheckReport	Laporan untuk informasi host sesi.
Status	Status untuk SessionHost.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UpdateState	Perbarui status SessionHost.

CloudError

Objek

Objek kesalahan cloud.

Nama	Jenis	Deskripsi
error	CloudErrorProperties	Properti objek kesalahan cloud.

CloudErrorProperties

Objek

Properti objek kesalahan cloud.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

HealthCheckName

Enumerasi

Mewakili nama operasi pemeriksaan kondisi yang dilakukan.

Nilai	Deskripsi
DomainJoinedCheck	Memverifikasi SessionHost bergabung ke domain. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena tidak ada koneksi yang dapat berhasil jika SessionHost tidak bergabung ke domain. (Saat ini diaktifkan)
DomainTrustCheck	Memverifikasi SessionHost tidak mengalami masalah kepercayaan domain yang akan mencegah autentikasi di SessionHost pada waktu koneksi saat sesi dibuat. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena tidak ada koneksi yang dapat berhasil jika kita tidak dapat menjangkau domain untuk autentikasi di SessionHost. (Saat ini diaktifkan)
FSLogixHealthCheck	Memverifikasi layanan FSLogix aktif dan berjalan untuk memastikan profil pengguna dimuat dalam sesi. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena meskipun koneksi dapat berhasil, pengalaman pengguna buruk karena profil pengguna tidak dapat dimuat dan pengguna akan mendapatkan profil sementara dalam sesi. (Saat ini Dinonaktifkan)
SxSStackListenerCheck	Memverifikasi bahwa tumpukan SxS aktif dan berjalan sehingga koneksi dapat berhasil. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena tidak ada koneksi yang dapat berhasil jika tumpukan SxS tidak siap. (Saat ini diaktifkan)
UrlsAccessibleCheck	Memverifikasi bahwa layanan WVD dan URL Jenewa yang diperlukan dapat dijangkau dari SessionHost. URL ini adalah: RdTokenUri, RdBrokerURI, RdDiagnosticsUri, dan URL blob penyimpanan untuk pemantauan agen (jenewa). Jika pemeriksaan ini gagal, itu tidak fatal dan mesin masih dapat melayani koneksi, masalah utama mungkin agen pemantauan tidak dapat menyimpan data jalur hangat (log, operasi ...). (Saat ini Dinonaktifkan)
MonitoringAgentCheck	Memverifikasi bahwa agen Jenewa yang diperlukan sedang berjalan. Jika pemeriksaan ini gagal, itu tidak fatal dan mesin masih dapat melayani koneksi, masalah utama mungkin agen pemantauan hilang atau berjalan (mungkin) versi yang lebih lama. (Saat ini diaktifkan)
DomainReachable	Memverifikasi domain tempat SessionHost bergabung masih dapat dijangkau. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena tidak ada koneksi yang dapat berhasil jika domain yang digabungkan dengan SessionHost tidak dapat dijangkau pada saat koneksi. (Saat ini Dinonaktifkan)
WebRTCRedirectorCheck	Memverifikasi apakah komponen WebRTCRedirector sehat. Komponen WebRTCRedirector digunakan untuk mengoptimalkan performa video dan audio di Microsoft Teams. Ini memeriksa apakah komponen masih berjalan, dan apakah ada versi yang lebih tinggi yang tersedia. Jika pemeriksaan ini gagal, itu tidak fatal dan mesin masih dapat melayani koneksi, masalah utama mungkin komponen WebRTCRedirector harus dimulai ulang atau diperbarui. (Saat ini Dinonaktifkan)
SupportedEncryptionCheck	Memverifikasi nilai kunci pendaftaran SecurityLayer. Jika nilainya 0 (SecurityLayer.RDP), pemeriksaan ini gagal dengan kode Error = NativeMethodErrorCode.E_FAIL dan berakibat fatal. Jika nilainya adalah 1 (SecurityLayer.Negotiate), pemeriksaan ini gagal dengan kode Error = NativeMethodErrorCode.ERROR_SUCCESS dan tidak berakibat fatal. (Saat ini Dinonaktifkan)
MetaDataServiceCheck	Memverifikasi layanan metadata dapat diakses dan mengembalikan properti komputasi. (Saat ini diaktifkan)
AppAttachHealthCheck	Memverifikasi bahwa AppAttachService sehat (tidak ada masalah selama penahapan paket). AppAttachService digunakan untuk mengaktifkan penahapan/pendaftaran (dan akhirnya pembatalan pendaftaran/pencatatan) aplikasi MSIX yang telah disiapkan oleh admin penyewa. Ini memeriksa apakah komponen mengalami kegagalan selama penahapan paket. Kegagalan dalam pementasan akan mencegah beberapa aplikasi MSIX berfungsi dengan baik untuk pengguna akhir. Jika pemeriksaan ini gagal, itu tidak fatal dan mesin masih dapat melayani koneksi, masalah utama mungkin aplikasi tertentu tidak akan berfungsi untuk pengguna akhir. (Saat ini diaktifkan)

HealthCheckResult

Enumerasi

Mewakili status Kesehatan pemeriksaan kesehatan yang kami lakukan.

Nilai	Deskripsi
Unknown	Hasil pemeriksaan kesehatan saat ini tidak diketahui.
HealthCheckSucceeded	Pemeriksaan kesehatan lulus.
HealthCheckFailed	Pemeriksaan kesehatan gagal.
SessionHostShutdown	Kami menerima pemberitahuan Shutdown.

SessionHost

Objek

Mewakili definisi SessionHost.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.agentVersion	string	Versi agen di SessionHost.
properties.allowNewSession	boolean	Izinkan sesi baru.
properties.assignedUser	string	Pengguna yang ditetapkan ke SessionHost.
properties.friendlyName	string	Nama SessionHost yang ramah
properties.lastHeartBeat	string (date-time)	Detak jantung terakhir dari SessionHost.
properties.lastUpdateTime	string (date-time)	Stempel waktu pembaruan terakhir.
properties.objectId	string	ObjectId dari SessionHost. (penggunaan internal)
properties.osVersion	string	Versi OS pada host sesi.
properties.resourceId	string	ID Sumber Daya dari komputer virtual yang mendasarinya SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Daftar SessionHostHealthCheckReports
properties.sessions	integer (int32)	Jumlah sesi di SessionHost.
properties.status	Status	Status untuk SessionHost.
properties.statusTimestamp	string (date-time)	Tanda waktu status.
properties.sxSStackVersion	string	Versi tumpukan berdampingan pada host sesi.
properties.updateErrorMessage	string	Pesan kesalahan.
properties.updateState	UpdateState	Perbarui status SessionHost.
properties.virtualMachineId	string	ID Komputer Virtual dari komputer virtual yang mendasarinya SessionHost.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Objek

Berisi detail tentang kegagalan.

Nama	Jenis	Deskripsi
errorCode	integer (int32)	Kode kesalahan sesuai dengan kegagalan.
lastHealthCheckDateTime	string (date-time)	Stempel waktu pembaruan terakhir.
message	string	Pesan kegagalan: petunjuk tentang apa yang salah dan cara memulihkannya.

SessionHostHealthCheckReport

Objek

Laporan untuk informasi host sesi.

Nama	Jenis	Deskripsi
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Informasi rinci tambahan tentang kegagalan.
healthCheckName	HealthCheckName	Mewakili nama operasi pemeriksaan kondisi yang dilakukan.
healthCheckResult	HealthCheckResult	Mewakili status Kesehatan pemeriksaan kesehatan yang kami lakukan.

Status

Enumerasi

Status untuk SessionHost.

Nilai	Deskripsi
Available	Host Sesi telah lulus semua pemeriksaan kondisi dan tersedia untuk menangani koneksi.
Unavailable	Host Sesi dimatikan atau telah gagal dalam pemeriksaan kondisi kritis yang menyebabkan layanan tidak dapat merutekan koneksi ke host sesi ini. Perhatikan bahwa ini menggantikan status 'NoHeartBeat' sebelumnya.
Shutdown	Host Sesi dimatikan - Agen RD melaporkan host sesi dihentikan atau dibatalkan alokasi.
Disconnected	Host Sesi tidak tersedia karena saat ini terputus.
Upgrading	Host Sesi tidak tersedia karena saat ini peningkatan RDAgent/side-by-side stack sedang berlangsung. Catatan: status ini akan dihapus setelah peningkatan selesai dan host dapat menerima koneksi.
UpgradeFailed	Host Sesi tidak tersedia karena peningkatan komponen penting (agen, tumpukan berdampingan, dll.) gagal.
NoHeartbeat	Pembawa Acara Sesi tidak berdetak jantung.
NotJoinedToDomain	SessionHost tidak bergabung ke domain.
DomainTrustRelationshipLost	Hubungan kepercayaan domain SessionHost hilang
SxSStackListenerNotReady	Tumpukan SxS yang diinstal pada SessionHost tidak siap untuk menerima koneksi.
FSLogixNotHealthy	FSLogix berada dalam keadaan tidak sehat pada host sesi.
NeedsAssistance	Status baru untuk memberi tahu admin bahwa kesehatan pada titik akhir mereka perlu diperbaiki. Koneksi mungkin tidak gagal, karena masalah ini tidak berakibat fatal.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UpdateState

Enumerasi

Perbarui status SessionHost.

Nilai	Deskripsi
Initial
Pending
Started
Succeeded
Failed

Bagikan melalui

Session Hosts - Get

Parameter URI

Respons

Contoh

SessionHost_Get

Permintaan sampel

Respon sampel

Definisi

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState