@azure/arm-desktopvirtualization package

The session host configuration for updating agent, monitoring agent, and stack component.

The session host configuration for updating agent, monitoring agent, and stack component.

Schema for App Attach Package properties.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AppAttachPackageInfo.

Optional parameters.

Optional parameters.

Schema for Import Package Information properties.

List of App Attach Package definitions.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AppAttachPackageOperations.

Schema for updatable App Attach Package properties.

Schema for patchable fields on an App Attach Package.

Schema for App Attach Package properties.

Optional parameters.

Schema for Application properties.

Represents a ApplicationGroup definition.

List of ApplicationGroup definitions.

ApplicationGroup properties that can be patched.

Interface representing a ApplicationGroups.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

List of Application definitions.

Application properties that can be patched.

Interface representing a Applications.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Cloud error object.

Cloud error object properties.

Schema for Desktop properties.

List of Desktop definitions.

Desktop properties that can be patched.

Optional parameters.

Interface representing a Desktops.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Represents the definition of contents retrieved after expanding the MSIX Image.

List of MSIX package properties retrieved from MSIX Image expansion.

Represents a HostPool definition.

List of HostPool definitions.

HostPool properties that can be patched.

Interface representing a HostPools.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Identity for the resource.

Information to import app attach package

Specifications of the Log for Azure Monitoring

Maintenance window starting hour and day of week.

Maintenance window starting hour and day of week.

Represents URI referring to MSIX Image

Interface representing a MsixImages.

Optional parameters.

Optional parameters.

Schema for MSIX Package properties.

Schema for MSIX Package Application properties.

Schema for MSIX Package Dependencies properties.

List of MSIX Package definitions.

MSIX Package properties that can be patched.

Interface representing a MsixPackages.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Properties of the operation

Interface representing a Operations.

Optional parameters.

Optional parameters.

Plan for the resource.

The private endpoint resource.

The private endpoint connection resource.

List of private endpoint connection associated with the specified storage account

The Private Endpoint Connection resource.

Interface representing a PrivateEndpointConnections.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A private link resource

A list of private link resources

Interface representing a PrivateLinkResources.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A collection of information about the state of the connection between service consumer and provider.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Represents a RegistrationInfo definition.

Represents a RegistrationInfo definition.

List of RegistrationToken definitions.

Represents a Minimal set of properties for RegistrationToken definition.

Common fields that are returned in the response for all Azure Resource Manager resources

The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.

Identity for the resource.

Plan for the resource.

The resource model definition representing SKU

Supported operation of this resource provider.

Display metadata associated with the operation.

Result of the request to list operations.

Scaling plan reference to hostpool.

Represents a scaling plan definition.

List of scaling plan definitions.

Scaling plan properties that can be patched.

Represents a ScalingPlanPersonalSchedule definition.

List of ScalingPlanPersonalSchedule definitions.

ScalingPlanPersonalSchedule properties that can be patched.

Interface representing a ScalingPlanPersonalSchedules.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Represents a ScalingPlanPooledSchedule definition.

List of ScalingPlanPooledSchedule definitions.

ScalingPlanPooledSchedule properties that can be patched.

Interface representing a ScalingPlanPooledSchedules.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ScalingPlans.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A ScalingPlanPooledSchedule.

Represents message sent to a UserSession.

Service specification payload

Represents a SessionHost definition.

Contains details on the failure.

The report for session host information.

List of SessionHost definitions.

SessionHost properties that can be patched.

Interface representing a SessionHosts.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The resource model definition representing SKU

Represents a StartMenuItem definition.

List of StartMenuItem definitions.

Interface representing a StartMenuItems.

Optional parameters.

Optional parameters.

Metadata pertaining to creation and last modification of the resource.

The time for a scaling action to occur.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Represents a UserSession definition.

List of UserSession definitions.

Interface representing a UserSessions.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Represents a Workspace definition.

List of Workspace definitions.

Workspace properties that can be patched.

Interface representing a Workspaces.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines values for AppAttachPackageArchitectures.
KnownAppAttachPackageArchitectures can be used interchangeably with AppAttachPackageArchitectures, this enum contains the known values that the service supports.

Known values supported by the service

ARM
ARM64
x86
x64
Neutral
x86a64
ALL

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the importNext operation.

Contains response data for the import operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the update operation.

Defines values for ApplicationGroupType.
KnownApplicationGroupType can be used interchangeably with ApplicationGroupType, this enum contains the known values that the service supports.

Known values supported by the service

RemoteApp
Desktop

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the update operation.

Defines values for ApplicationType.
KnownApplicationType can be used interchangeably with ApplicationType, this enum contains the known values that the service supports.

Known values supported by the service

RemoteApp
Desktop

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for CommandLineSetting.
KnownCommandLineSetting can be used interchangeably with CommandLineSetting, this enum contains the known values that the service supports.

Known values supported by the service

DoNotAllow
Allow
Require

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for DayOfWeek.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for FailHealthCheckOnStagingFailure.
KnownFailHealthCheckOnStagingFailure can be used interchangeably with FailHealthCheckOnStagingFailure, this enum contains the known values that the service supports.

Known values supported by the service

Unhealthy
NeedsAssistance
DoNotFail

Defines values for HealthCheckName.
KnownHealthCheckName can be used interchangeably with HealthCheckName, this enum contains the known values that the service supports.

Known values supported by the service

DomainJoinedCheck: Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)
DomainTrustCheck: Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)
FSLogixHealthCheck: Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)
SxSStackListenerCheck: Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)
UrlsAccessibleCheck: Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)
MonitoringAgentCheck: Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)
DomainReachable: Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)
WebRTCRedirectorCheck: Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)
SupportedEncryptionCheck: Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)
MetaDataServiceCheck: Verifies the metadata service is accessible and return compute properties. (Currently Enabled)
AppAttachHealthCheck: Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)

Defines values for HealthCheckResult.
KnownHealthCheckResult can be used interchangeably with HealthCheckResult, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Health check result is not currently known.
HealthCheckSucceeded: Health check passed.
HealthCheckFailed: Health check failed.
SessionHostShutdown: We received a Shutdown notification.

Defines values for HostPoolType.
KnownHostPoolType can be used interchangeably with HostPoolType, this enum contains the known values that the service supports.

Known values supported by the service

Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool.
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listNext operation.

Contains response data for the listRegistrationTokens operation.

Contains response data for the list operation.

Contains response data for the retrieveRegistrationToken operation.

Contains response data for the update operation.

Defines values for HostpoolPublicNetworkAccess.
KnownHostpoolPublicNetworkAccess can be used interchangeably with HostpoolPublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled
EnabledForSessionHostsOnly
EnabledForClientsOnly

Defines values for LoadBalancerType.
KnownLoadBalancerType can be used interchangeably with LoadBalancerType, this enum contains the known values that the service supports.

Known values supported by the service

BreadthFirst
DepthFirst
Persistent

Contains response data for the expandNext operation.

Contains response data for the expand operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for PackageTimestamped.
KnownPackageTimestamped can be used interchangeably with PackageTimestamped, this enum contains the known values that the service supports.

Known values supported by the service

Timestamped
NotTimestamped

Defines values for PersonalDesktopAssignmentType.
KnownPersonalDesktopAssignmentType can be used interchangeably with PersonalDesktopAssignmentType, this enum contains the known values that the service supports.

Known values supported by the service

Automatic
Direct

Defines values for PreferredAppGroupType.
KnownPreferredAppGroupType can be used interchangeably with PreferredAppGroupType, this enum contains the known values that the service supports.

Known values supported by the service

None
Desktop
RailApplications

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

Contains response data for the getByHostPool operation.

Contains response data for the getByWorkspace operation.

Contains response data for the listByHostPoolNext operation.

Contains response data for the listByHostPool operation.

Contains response data for the listByWorkspaceNext operation.

Contains response data for the listByWorkspace operation.

Contains response data for the updateByHostPool operation.

Contains response data for the updateByWorkspace operation.

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

Contains response data for the listByHostPoolNext operation.

Contains response data for the listByHostPool operation.

Contains response data for the listByWorkspaceNext operation.

Contains response data for the listByWorkspace operation.

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Provisioning
Failed
Canceled

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Defines values for RegistrationTokenOperation.
KnownRegistrationTokenOperation can be used interchangeably with RegistrationTokenOperation, this enum contains the known values that the service supports.

Known values supported by the service

Delete
None
Update

Defines values for RemoteApplicationType.
KnownRemoteApplicationType can be used interchangeably with RemoteApplicationType, this enum contains the known values that the service supports.

Known values supported by the service

InBuilt
MsixApplication

Defines values for SSOSecretType.
KnownSSOSecretType can be used interchangeably with SSOSecretType, this enum contains the known values that the service supports.

Known values supported by the service

SharedKey
Certificate
SharedKeyInKeyVault
CertificateInKeyVault

Defines values for ScalingHostPoolType.
KnownScalingHostPoolType can be used interchangeably with ScalingHostPoolType, this enum contains the known values that the service supports.

Known values supported by the service

Pooled: Users get a new (random) SessionHost every time it connects to the HostPool.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listByHostPoolNext operation.

Contains response data for the listByHostPool operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the update operation.

Defines values for ScalingScheduleDaysOfWeekItem.
KnownScalingScheduleDaysOfWeekItem can be used interchangeably with ScalingScheduleDaysOfWeekItem, this enum contains the known values that the service supports.

Known values supported by the service

Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

Defines values for SessionHandlingOperation.
KnownSessionHandlingOperation can be used interchangeably with SessionHandlingOperation, this enum contains the known values that the service supports.

Known values supported by the service

None
Deallocate
Hibernate

Defines values for SessionHostComponentUpdateType.
KnownSessionHostComponentUpdateType can be used interchangeably with SessionHostComponentUpdateType, this enum contains the known values that the service supports.

Known values supported by the service

Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra.
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature.

Defines values for SessionHostLoadBalancingAlgorithm.
KnownSessionHostLoadBalancingAlgorithm can be used interchangeably with SessionHostLoadBalancingAlgorithm, this enum contains the known values that the service supports.

Known values supported by the service

BreadthFirst
DepthFirst

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for SessionState.
KnownSessionState can be used interchangeably with SessionState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Active
Disconnected
Pending
LogOff
UserProfileDiskMounted

Defines values for SetStartVMOnConnect.
KnownSetStartVMOnConnect can be used interchangeably with SetStartVMOnConnect, this enum contains the known values that the service supports.

Known values supported by the service

Enable
Disable

Defines values for SkuTier.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for StartupBehavior.
KnownStartupBehavior can be used interchangeably with StartupBehavior, this enum contains the known values that the service supports.

Known values supported by the service

None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts.
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up
All: All personal session hosts in the hostpool will be started during ramp up.

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Available: Session Host has passed all the health checks and is available to handle connections.
Unavailable: Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status.
Shutdown: Session Host is shutdown - RD Agent reported session host to be stopped or deallocated.
Disconnected: The Session Host is unavailable because it is currently disconnected.
Upgrading: Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections.
UpgradeFailed: Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed.
NoHeartbeat: The Session Host is not heart beating.
NotJoinedToDomain: SessionHost is not joined to domain.
DomainTrustRelationshipLost: SessionHost's domain trust relationship lost
SxSStackListenerNotReady: SxS stack installed on the SessionHost is not ready to receive connections.
FSLogixNotHealthy: FSLogix is in an unhealthy state on the session host.
NeedsAssistance: New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal.

Defines values for StopHostsWhen.
KnownStopHostsWhen can be used interchangeably with StopHostsWhen, this enum contains the known values that the service supports.

Known values supported by the service

ZeroSessions
ZeroActiveSessions

Defines values for UpdateState.
KnownUpdateState can be used interchangeably with UpdateState, this enum contains the known values that the service supports.

Known values supported by the service

Initial
Pending
Started
Succeeded
Failed

Contains response data for the get operation.

Contains response data for the listByHostPoolNext operation.

Contains response data for the listByHostPool operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the update operation.

Known values of AppAttachPackageArchitectures that the service accepts.

Known values of ApplicationGroupType that the service accepts.

Known values of ApplicationType that the service accepts.

Known values of CommandLineSetting that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of FailHealthCheckOnStagingFailure that the service accepts.

Known values of HealthCheckName that the service accepts.

Known values of HealthCheckResult that the service accepts.

Known values of HostPoolType that the service accepts.

Known values of HostpoolPublicNetworkAccess that the service accepts.

Known values of LoadBalancerType that the service accepts.

Known values of PackageTimestamped that the service accepts.

Known values of PersonalDesktopAssignmentType that the service accepts.

Known values of PreferredAppGroupType that the service accepts.

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of RegistrationTokenOperation that the service accepts.

Known values of RemoteApplicationType that the service accepts.

Known values of SSOSecretType that the service accepts.

Known values of ScalingHostPoolType that the service accepts.

Known values of ScalingScheduleDaysOfWeekItem that the service accepts.

Known values of SessionHandlingOperation that the service accepts.

Known values of SessionHostComponentUpdateType that the service accepts.

Known values of SessionHostLoadBalancingAlgorithm that the service accepts.

Known values of SessionState that the service accepts.

Known values of SetStartVMOnConnect that the service accepts.

Known values of StartupBehavior that the service accepts.

Known values of Status that the service accepts.

Known values of StopHostsWhen that the service accepts.

Known values of UpdateState that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.