HostPoolPatch 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.
HostPool properties that can be patched.
public class HostPoolPatch : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DesktopVirtualization.Models.HostPoolPatch>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DesktopVirtualization.Models.HostPoolPatch>
type HostPoolPatch = class
inherit ResourceData
interface IJsonModel<HostPoolPatch>
interface IPersistableModel<HostPoolPatch>
Public Class HostPoolPatch
Inherits ResourceData
Implements IJsonModel(Of HostPoolPatch), IPersistableModel(Of HostPoolPatch)
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| HostPoolPatch() |
Initializes a new instance of HostPoolPatch. |
Properties
| Name | Description |
|---|---|
| AgentUpdate |
The session host configuration for updating agent, monitoring agent, and stack component. |
| AllowRdpShortPathWithPrivateLink |
Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes. |
| CustomRdpProperty |
Custom rdp property of HostPool. |
| Description |
Description of HostPool. |
| DirectUdp |
Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections. |
| FriendlyName |
Friendly name of HostPool. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| Identity |
The managed service identities assigned to this resource. |
| IsValidationEnvironment |
Is validation environment. |
| LoadBalancerType |
The type of the load balancer. |
| ManagedPrivateUdp |
Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections. |
| MaxSessionLimit |
The max session limit of HostPool. |
| Name |
The name of the resource. (Inherited from ResourceData) |
| PersonalDesktopAssignmentType |
PersonalDesktopAssignment type for HostPool. |
| PreferredAppGroupType |
The type of preferred application group type, default to Desktop Application Group. |
| PublicNetworkAccess |
Enabled to allow this resource to be access from the public network. |
| PublicUdp |
Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections. |
| RegistrationInfo |
The registration info of HostPool. |
| RelayUdp |
Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections. |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| Ring |
The ring number of HostPool. |
| SsoAdfsAuthority |
URL to customer ADFS server for signing WVD SSO certificates. |
| SsoClientId |
ClientId for the registered Relying Party used to issue WVD SSO certificates. |
| SsoClientSecretKeyVaultPath |
Path to Azure KeyVault storing the secret used for communication to ADFS. |
| SsoSecretType |
The type of single sign on Secret Type. |
| StartVmOnConnect |
The flag to turn on/off StartVMOnConnect feature. |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| Tags |
tags to be updated. |
| VmTemplate |
VM template for sessionhosts configuration within hostpool. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<HostPoolPatch>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<HostPoolPatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<HostPoolPatch>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<HostPoolPatch>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<HostPoolPatch>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |