Session Hosts - Get

Mendapatkan host sesi.

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

Parameter URI

Name In Required Type Description
hostPoolName
path True
  • string

Nama kumpulan host dalam grup sumber daya yang ditentukan

resourceGroupName
path True
  • string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

sessionHostName
path True
  • string

Nama host sesi dalam kumpulan host yang ditentukan

subscriptionId
path True
  • string

ID langganan target.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Respons

Name Type Description
200 OK

Berhasil mengambil host sesi.

Other Status Codes

Respons kesalahan automasi yang menjelaskan mengapa operasi gagal.

Contoh

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=2022-02-10-preview

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

CloudError

Objek kesalahan cloud.

CloudErrorProperties

Properti objek kesalahan cloud.

createdByType

Jenis identitas yang membuat sumber daya.

HealthCheckName

Mewakili nama operasi pemeriksaan kesehatan yang dilakukan.

HealthCheckResult

Mewakili status Kesehatan dari 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

Memperbarui status SessionHost.

CloudError

Objek kesalahan cloud.

Name Type Description
error

Properti objek kesalahan cloud.

CloudErrorProperties

Properti objek kesalahan cloud.

Name Type Description
code
  • string

Kode kesalahan

message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

createdByType

Jenis identitas yang membuat sumber daya.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

HealthCheckName

Mewakili nama operasi pemeriksaan kesehatan yang dilakukan.

Name Type Description
AppAttachHealthCheck
  • string

Memverifikasi bahwa AppAttachService sehat (tidak ada masalah selama penahapan paket). AppAttachService digunakan untuk mengaktifkan penahapan/pendaftaran (dan deregistrasi/destaging akhir) aplikasi MSIX yang telah disiapkan oleh admin penyewa. Ini memeriksa apakah komponen mengalami kegagalan selama penahapan paket. Kegagalan dalam penahapan 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.

DomainJoinedCheck
  • string

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.

DomainReachable
  • string

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 bergabung dengan SessionHost tidak dapat dijangkau pada saat koneksi.

DomainTrustCheck
  • string

Memverifikasi SessionHost tidak mengalami masalah kepercayaan domain yang akan mencegah autentikasi pada SessionHost pada waktu koneksi saat sesi dibuat. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal karena tidak ada koneksi yang dapat berhasil jika kami tidak dapat menjangkau domain untuk autentikasi pada SessionHost.

FSLogixHealthCheck
  • string

Memverifikasi layanan FSLogix aktif dan berjalan untuk memastikan profil pengguna dimuat dalam sesi. Jika pemeriksaan ini gagal diklasifikasikan sebagai fatal seolah-olah koneksi dapat berhasil, pengalaman pengguna buruk karena profil pengguna tidak dapat dimuat dan pengguna akan mendapatkan profil sementara dalam sesi.

MetaDataServiceCheck
  • string

Memverifikasi layanan metadata dapat diakses dan mengembalikan properti komputasi.

MonitoringAgentCheck
  • string

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 lama.

SupportedEncryptionCheck
  • string

Memverifikasi nilai kunci pendaftaran SecurityLayer. Jika nilainya adalah 0 (SecurityLayer.RDP) pemeriksaan ini gagal dengan Kode kesalahan = NativeMethodErrorCode.E_FAIL dan bersifat fatal. Jika nilainya adalah 1 (SecurityLayer.Negotiate) pemeriksaan ini gagal dengan Kode kesalahan = NativeMethodErrorCode.ERROR_SUCCESS dan tidak fatal.

SxSStackListenerCheck
  • string

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 belum siap.

UrlsAccessibleCheck
  • string

Memverifikasi bahwa layanan WVD yang diperlukan dan URL Jenewa 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 ...).

WebRTCRedirectorCheck
  • string

Memverifikasi apakah komponen WebRTCRedirector sehat. Komponen WebRTCRedirector digunakan untuk mengoptimalkan performa video dan audio dalam 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.

HealthCheckResult

Mewakili status Kesehatan dari pemeriksaan kesehatan yang kami lakukan.

Name Type Description
HealthCheckFailed
  • string

Pemeriksaan kesehatan gagal.

HealthCheckSucceeded
  • string

Pemeriksaan kesehatan lulus.

SessionHostShutdown
  • string

Kami menerima pemberitahuan Matikan.

Unknown
  • string

Hasil pemeriksaan kesehatan saat ini tidak diketahui.

SessionHost

Mewakili definisi SessionHost.

Name Type Description
id
  • string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /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 yang mudah diingat dari SessionHost

properties.lastHeartBeat
  • string

Detak jantung terakhir dari SessionHost.

properties.lastUpdateTime
  • string

Tanda 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 mendasar SessionHost.

properties.sessionHostHealthCheckResults

Daftar SessionHostHealthCheckReports

properties.sessions
  • integer

Jumlah sesi di SessionHost.

properties.status

Status untuk SessionHost.

properties.statusTimestamp
  • string

Tanda waktu status.

properties.sxSStackVersion
  • string

Versi tumpukan berdampingan pada host sesi.

properties.updateErrorMessage
  • string

Pesan kesalahan.

properties.updateState

Memperbarui status SessionHost.

properties.virtualMachineId
  • string

Id Komputer Virtual dari komputer virtual yang mendasar SessionHost.

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

Berisi detail tentang kegagalan.

Name Type Description
errorCode
  • integer

Kode kesalahan yang sesuai dengan kegagalan.

lastHealthCheckDateTime
  • string

Tanda waktu pembaruan terakhir.

message
  • string

Pesan kegagalan: petunjuk tentang apa yang salah dan cara memulihkan.

SessionHostHealthCheckReport

Laporan untuk informasi host sesi.

Name Type Description
additionalFailureDetails

Informasi terperinci tambahan tentang kegagalan.

healthCheckName

Mewakili nama operasi pemeriksaan kesehatan yang dilakukan.

healthCheckResult

Mewakili status Kesehatan dari pemeriksaan kesehatan yang kami lakukan.

Status

Status untuk SessionHost.

Name Type Description
Available
  • string

Host Sesi telah melewati semua pemeriksaan kesehatan dan tersedia untuk menangani koneksi.

Disconnected
  • string

Host Sesi tidak tersedia karena saat ini terputus.

DomainTrustRelationshipLost
  • string

Hubungan kepercayaan domain SessionHost hilang

FSLogixNotHealthy
  • string

FSLogix dalam keadaan tidak sehat pada host sesi.

NeedsAssistance
  • string

Status baru untuk memberi tahu admin bahwa kesehatan pada titik akhir mereka perlu diperbaiki. Koneksi mungkin tidak gagal, karena masalah ini tidak fatal.

NoHeartbeat
  • string

Host Sesi tidak berdetak jantung.

NotJoinedToDomain
  • string

SessionHost tidak bergabung ke domain.

Shutdown
  • string

Host Sesi dimatikan - Agen RD melaporkan host sesi yang akan dihentikan atau dibatalkan alokasinya.

SxSStackListenerNotReady
  • string

Tumpukan SxS yang diinstal pada SessionHost belum siap untuk menerima koneksi.

Unavailable
  • string

Host Sesi dimatikan atau telah gagal pemeriksaan kesehatan kritis yang menyebabkan layanan tidak dapat merutekan koneksi ke host sesi ini. Perhatikan bahwa ini menggantikan status 'NoHeartBeat' sebelumnya.

UpgradeFailed
  • string

Host Sesi tidak tersedia karena peningkatan komponen penting (agen, tumpukan berdampingan, dll.) gagal.

Upgrading
  • string

Host Sesi tidak tersedia karena saat ini peningkatan tumpukan RDAgent/berdampingan sedang berlangsung. Catatan: status ini akan dihapus setelah peningkatan selesai dan host dapat menerima koneksi.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy
  • string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

UpdateState

Memperbarui status SessionHost.

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