Azure.ResourceManager.DesktopVirtualization.Models Namespace
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.
Classes
| Name | Description |
|---|---|
| ActiveSessionHostConfigurationProperties |
Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState. |
| AppAttachPackageInfoProperties |
Schema for Import Package Information properties. |
| AppAttachPackagePatch |
Schema for updatable App Attach Package properties. |
| AppAttachPackagePatchProperties |
Schema for patchable fields on an App Attach Package. |
| AppAttachPackageProperties |
Schema for App Attach Package properties. |
| ArmDesktopVirtualizationModelFactory |
A factory class for creating instances of the models for mocking. |
| DesktopVirtualizationActiveDirectoryInfoProperties |
Active directory info. Only one should be populated based on the join type. |
| DesktopVirtualizationBootDiagnosticsInfoPatchProperties |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. |
| DesktopVirtualizationBootDiagnosticsInfoProperties |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. |
| DesktopVirtualizationCreateDeleteProperties |
The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. |
| DesktopVirtualizationDiffDiskProperties |
Specifies the ephemeral disk settings for the operating system disk used by the virtual machine. |
| DesktopVirtualizationDiskInfoProperties |
Disk information. |
| DesktopVirtualizationDomainInfoProperties |
Domain configurations of session hosts. |
| DesktopVirtualizationImageInfoPatchProperties |
Image configurations of session host in a HostPool. |
| DesktopVirtualizationImageInfoProperties |
Image configurations of session host in a HostPool. |
| DesktopVirtualizationKeyVaultCredentialsPatchProperties |
Credentials kept in the keyvault. |
| DesktopVirtualizationKeyVaultCredentialsProperties |
Credentials kept in the keyvault. |
| DesktopVirtualizationMarketplaceInfoPatchProperties |
Marketplace image information. |
| DesktopVirtualizationMarketplaceInfoProperties |
Marketplace image information. |
| DesktopVirtualizationNetworkInfoPatchProperties |
Network information. |
| DesktopVirtualizationNetworkInfoProperties |
Network information. |
| DesktopVirtualizationPrivateEndpointConnection |
The private endpoint connection resource. |
| DesktopVirtualizationPrivateLinkResourceData |
A private link resource. |
| DesktopVirtualizationPrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| DesktopVirtualizationRegistrationTokenMinimal |
Represents a Minimal set of properties for RegistrationToken definition. |
| DesktopVirtualizationSecurityInfoPatchProperties |
Security Information. |
| DesktopVirtualizationSecurityInfoProperties |
Security Information. |
| DesktopVirtualizationSku |
The resource model definition representing SKU. |
| DesktopVirtualizationStartMenuItem |
Represents a StartMenuItem definition. |
| DesktopVirtualizationUpdateSessionHostsContent |
Object containing the definition for properties to be used for a sessionHostUpdate operation. |
| ExpandMsixImage |
Represents the definition of contents retrieved after expanding the MSIX Image. |
| HostPoolPatch |
HostPool properties that can be patched. |
| HostPoolProvisioningControlContent |
Object containing control action for hostpool provisioning. |
| HostPoolRegistrationInfo |
Represents a RegistrationInfo definition. |
| HostPoolRegistrationInfoPatch |
Represents a RegistrationInfo definition. |
| HostPoolUpdateConfigurationPatchProperties |
The configurations of a hostpool update. |
| HostPoolUpdateConfigurationProperties |
The configurations of a hostpool update. |
| HostPoolUpdateControlContent |
Object containing control action for hostpool update. |
| ImportPackageInfoContent |
Information to import app attach package. |
| MaintenanceWindowPatchProperties |
Maintenance window starting hour and day of week. |
| MsixImageUri |
Represents URI referring to MSIX Image. |
| MsixPackageApplications |
Schema for MSIX Package Application properties. |
| MsixPackageDependencies |
Schema for MSIX Package Dependencies properties. |
| MsixPackagePatch |
MSIX Package properties that can be patched. |
| ScalingActionTime |
The time for a scaling action to occur. |
| ScalingHostPoolReference |
Scaling plan reference to hostpool. |
| ScalingPlanPatch |
Scaling plan properties that can be patched. |
| ScalingPlanPersonalSchedulePatch |
ScalingPlanPersonalSchedule properties that can be patched. |
| ScalingPlanPooledSchedulePatch |
ScalingPlanPooledSchedule properties that can be patched. |
| ScalingSchedule |
Scaling plan schedule. |
| ScopedRegistrationTokenContent |
Request body for listing scoped registration tokens for a session host. |
| SessionHostAgentUpdatePatchProperties |
The session host configuration for updating agent, monitoring agent, and stack component. |
| SessionHostAgentUpdateProperties |
The session host configuration for updating agent, monitoring agent, and stack component. |
| SessionHostConfigurationPatch |
SessionHostConfiguration properties that can be patched. |
| SessionHostConfigurationPatchProperties |
Session host configurations of HostPool. |
| SessionHostConfigurationProperties |
Session host configurations of HostPool. |
| SessionHostHealthCheckFailureDetails |
Contains details on the failure. |
| SessionHostHealthCheckReport |
The report for session host information. |
| SessionHostMaintenanceWindowProperties |
Maintenance window starting hour and day of week. |
| SessionHostManagementOperationProgress |
SessionHostManagement Operation Progress information. |
| SessionHostManagementPatch |
SessionHostManagement properties that can be patched. |
| SessionHostManagementPatchProperties |
Represents a SessionHostManagementPatch definition. |
| SessionHostManagementProperties |
Session Host Managements of HostPool. |
| SessionHostManagementProvisioningOperationProgress |
SessionHostManagement Provisioning Operation Progress information. |
| SessionHostManagementProvisioningStatus |
Schema for SessionHostManagementUpdateStatus properties. |
| SessionHostManagementProvisioningStatusProperties |
Properties bag for sessionHostManagement Provisioning Statuses. |
| SessionHostManagementUpdateStatus |
Schema for SessionHostManagementUpdateStatus properties. |
| SessionHostManagementUpdateStatusProperties |
The current status of the session host update async operation. |
| SessionHostPatch |
SessionHost properties that can be patched. |
| SessionHostProvisioningConfigurationPatchProperties |
The configuration for session host provisioning operations. |
| SessionHostProvisioningConfigurationProperties |
The configuration for session host provisioning operations. |
| UserSessionMessage |
Represents message sent to a UserSession. |
| VirtualApplicationGroupPatch |
ApplicationGroup properties that can be patched. |
| VirtualApplicationPatch |
Application properties that can be patched. |
| VirtualDesktopPatch |
Desktop properties that can be patched. |
| VirtualWorkspacePatch |
Workspace properties that can be patched. |
Structs
| Name | Description |
|---|---|
| AppAttachPackageArchitecture |
Possible device architectures that an app attach package can be configured for. |
| AppAttachPackageProvisioningState |
The current provisioning state. |
| DesktopVirtualizationAllowRdpShortPathWithPrivateLink |
Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes. |
| DesktopVirtualizationCanaryPolicy |
Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation. |
| DesktopVirtualizationDeploymentScope |
DeploymentScope type for HostPool. |
| DesktopVirtualizationDiffDiskOption |
Specifies the ephemeral disk settings for operating system disk. |
| DesktopVirtualizationDiffDiskPlacement |
Gets or sets specifies the ephemeral disk placement for operating system disk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'. |
| DesktopVirtualizationDirectUdp |
Direct UDP Connection Settings. |
| DesktopVirtualizationDomainJoinType |
The type of domain join done by the virtual machine. |
| DesktopVirtualizationImageType |
The type of image session hosts use in the hostpool. |
| DesktopVirtualizationManagedPrivateUdp |
Managed Private UDP Connection Settings. |
| DesktopVirtualizationManagementType |
The type of management for the hostpool. |
| DesktopVirtualizationPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| DesktopVirtualizationPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| DesktopVirtualizationPublicNetworkAccess |
Enabled to allow this resource to be access from the public network. |
| DesktopVirtualizationPublicUdp |
Public UDP Connection Settings. |
| DesktopVirtualizationRelayUdp |
Relay UDP Connection Settings. |
| DesktopVirtualizationScalingMethodType |
The desired scaling method to be used to scale the hosts in the assigned host pool. |
| DesktopVirtualizationStopHostsWhen |
Specifies when to stop hosts during ramp down period. |
| DesktopVirtualizationVirtualMachineDiskType |
The disk type used by virtual machine in hostpool session host. |
| DesktopVirtualizationVirtualMachineSecurityType |
The security type used by virtual machine in hostpool session host. Default is Standard. |
| FailHealthCheckOnStagingFailure |
Parameter indicating how the health check should behave if this package fails staging. |
| HostPoolLoadBalancerType |
The type of the load balancer. |
| HostPoolProvisioningAction |
Action types for controlling hostpool provisioning. |
| HostPoolPublicNetworkAccess |
Enabled to allow this resource to be access from the public network. |
| HostPoolRegistrationTokenOperation |
The type of resetting the token. |
| HostPoolSsoSecretType |
The type of single sign on Secret Type. |
| HostPoolType |
HostPool type for desktop. |
| HostPoolUpdateAction |
Action types for controlling hostpool update. |
| PackageTimestamped |
Is package timestamped so it can ignore the certificate expiry date. |
| PersonalDesktopAssignmentType |
PersonalDesktopAssignment type for HostPool. |
| PreferredAppGroupType |
The type of preferred application group type, default to Desktop Application Group. |
| RemoteApplicationType |
Resource Type of Application. |
| ScalingHostPoolType |
HostPool type for desktop. |
| ScalingScheduleDaysOfWeekItem |
Day of the week. Modeled as string. |
| SessionHandlingOperation |
Action to be taken after a user disconnect during the ramp up period. |
| SessionHostComponentUpdateType |
The type of maintenance for session host components. |
| SessionHostConfigurationFailedSessionHostCleanupPolicy |
The policy that should be applied when the Session Host provisioning operation fails. |
| SessionHostConfigurationProvisioningState |
Provisioning state of the Session Host Configuration. |
| SessionHostHealthCheckName |
Represents the name of the health check operation performed. |
| SessionHostHealthCheckResult |
Represents the Health state of the health check we performed. |
| SessionHostLoadBalancingAlgorithm |
Load balancing algorithm for ramp up period. |
| SessionHostManagementProvisioningOperationStatus |
Operation status for SessionHostManagementUpdate. |
| SessionHostManagementUpdateOperationStatus |
Operation status for SessionHostManagementUpdate. |
| SessionHostStatus |
Status for a SessionHost. |
| SessionHostUpdateState |
Update state of a SessionHost. |
| SetStartVmOnConnect |
The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. |
| StartupBehavior |
The desired startup behavior during the ramp up period for personal vms in the hostpool. |
| UserSessionState |
State of user session. |
| VirtualApplicationCommandLineSetting |
Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. |
| VirtualApplicationGroupType |
Resource Type of ApplicationGroup. |
| VirtualApplicationType |
Application type of application. |
Enums
| Name | Description |
|---|---|
| DesktopVirtualizationDayOfWeek |
Day of the week. Modeled as string. |
| DesktopVirtualizationSkuTier |
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. |