SessionHostData Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing the SessionHost data model. Represents a SessionHost definition.
public class SessionHostData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DesktopVirtualization.SessionHostData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DesktopVirtualization.SessionHostData>type SessionHostData = class
inherit ResourceData
interface IJsonModel<SessionHostData>
interface IPersistableModel<SessionHostData>Public Class SessionHostData
Inherits ResourceData
Implements IJsonModel(Of SessionHostData), IPersistableModel(Of SessionHostData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SessionHostData() |
Initializes a new instance of SessionHostData. |
Properties
| Name | Description |
|---|---|
| ActiveSessions |
Number of active sessions on SessionHost. |
| AllowNewSession |
Allow a new session. |
| AssignedUser |
User assigned to SessionHost. |
| DisconnectedSessions |
Number of disconnected sessions on SessionHost. |
| FriendlyName |
Friendly name of SessionHost. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| LastSessionHostUpdateOn |
The last time update was completed. |
| LastUpdatedOn |
The timestamp of the last update. |
| Name |
The name of the resource. (Inherited from ResourceData) |
| ObjectId |
ObjectId of SessionHost. (internal use). |
| PendingSessions |
Number of pending sessions on SessionHost. |
| ResourceId |
Resource Id of SessionHost's underlying virtual machine. |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| SessionHostConfiguration |
SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z. |
| SessionHostHealthCheckResults |
List of SessionHostHealthCheckReports. |
| StatusTimestamp |
The timestamp of the status. |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| VmId |
Virtual Machine Id of SessionHost's underlying virtual machine. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SessionHostData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SessionHostData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SessionHostData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SessionHostData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SessionHostData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
