@azure/arm-desktopvirtualization package

Classes

DesktopVirtualizationAPIClient

Interfaces

AgentUpdatePatchProperties	The session host configuration for updating agent, monitoring agent, and stack component.
AgentUpdateProperties	The session host configuration for updating agent, monitoring agent, and stack component.
Application	Schema for Application properties.
ApplicationGroup	Represents a ApplicationGroup definition.
ApplicationGroupList	List of ApplicationGroup definitions.
ApplicationGroupPatch	ApplicationGroup properties that can be patched.
ApplicationGroups	Interface representing a ApplicationGroups.
ApplicationGroupsCreateOrUpdateOptionalParams	Optional parameters.
ApplicationGroupsDeleteOptionalParams	Optional parameters.
ApplicationGroupsGetOptionalParams	Optional parameters.
ApplicationGroupsListByResourceGroupNextOptionalParams	Optional parameters.
ApplicationGroupsListByResourceGroupOptionalParams	Optional parameters.
ApplicationGroupsListBySubscriptionNextOptionalParams	Optional parameters.
ApplicationGroupsListBySubscriptionOptionalParams	Optional parameters.
ApplicationGroupsUpdateOptionalParams	Optional parameters.
ApplicationList	List of Application definitions.
ApplicationPatch	Application properties that can be patched.
Applications	Interface representing a Applications.
ApplicationsCreateOrUpdateOptionalParams	Optional parameters.
ApplicationsDeleteOptionalParams	Optional parameters.
ApplicationsGetOptionalParams	Optional parameters.
ApplicationsListNextOptionalParams	Optional parameters.
ApplicationsListOptionalParams	Optional parameters.
ApplicationsUpdateOptionalParams	Optional parameters.
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
Desktop	Schema for Desktop properties.
DesktopList	List of Desktop definitions.
DesktopPatch	Desktop properties that can be patched.
DesktopVirtualizationAPIClientOptionalParams	Optional parameters.
Desktops	Interface representing a Desktops.
DesktopsGetOptionalParams	Optional parameters.
DesktopsListNextOptionalParams	Optional parameters.
DesktopsListOptionalParams	Optional parameters.
DesktopsUpdateOptionalParams	Optional parameters.
ExpandMsixImage	Represents the definition of contents retrieved after expanding the MSIX Image.
ExpandMsixImageList	List of MSIX package properties retrieved from MSIX Image expansion.
HostPool	Represents a HostPool definition.
HostPoolList	List of HostPool definitions.
HostPoolPatch	HostPool properties that can be patched.
HostPools	Interface representing a HostPools.
HostPoolsCreateOrUpdateOptionalParams	Optional parameters.
HostPoolsDeleteOptionalParams	Optional parameters.
HostPoolsGetOptionalParams	Optional parameters.
HostPoolsListByResourceGroupNextOptionalParams	Optional parameters.
HostPoolsListByResourceGroupOptionalParams	Optional parameters.
HostPoolsListNextOptionalParams	Optional parameters.
HostPoolsListOptionalParams	Optional parameters.
HostPoolsRetrieveRegistrationTokenOptionalParams	Optional parameters.
HostPoolsUpdateOptionalParams	Optional parameters.
Identity	Identity for the resource.
LogSpecification	Specifications of the Log for Azure Monitoring
MaintenanceWindowPatchProperties	Maintenance window starting hour and day of week.
MaintenanceWindowProperties	Maintenance window starting hour and day of week.
MsixImageURI	Represents URI referring to MSIX Image
MsixImages	Interface representing a MsixImages.
MsixImagesExpandNextOptionalParams	Optional parameters.
MsixImagesExpandOptionalParams	Optional parameters.
MsixPackage	Schema for MSIX Package properties.
MsixPackageApplications	Schema for MSIX Package Application properties.
MsixPackageDependencies	Schema for MSIX Package Dependencies properties.
MsixPackageList	List of MSIX Package definitions.
MsixPackagePatch	MSIX Package properties that can be patched.
MsixPackages	Interface representing a MsixPackages.
MsixPackagesCreateOrUpdateOptionalParams	Optional parameters.
MsixPackagesDeleteOptionalParams	Optional parameters.
MsixPackagesGetOptionalParams	Optional parameters.
MsixPackagesListNextOptionalParams	Optional parameters.
MsixPackagesListOptionalParams	Optional parameters.
MsixPackagesUpdateOptionalParams	Optional parameters.
OperationProperties	Properties of the operation
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
Plan	Plan for the resource.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResultWithSystemData	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnectionWithSystemData	The Private Endpoint Connection resource.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteByHostPoolOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteByWorkspaceOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetByHostPoolOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetByWorkspaceOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByHostPoolNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByHostPoolOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByWorkspaceNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByWorkspaceOptionalParams	Optional parameters.
PrivateEndpointConnectionsUpdateByHostPoolOptionalParams	Optional parameters.
PrivateEndpointConnectionsUpdateByWorkspaceOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListByHostPoolNextOptionalParams	Optional parameters.
PrivateLinkResourcesListByHostPoolOptionalParams	Optional parameters.
PrivateLinkResourcesListByWorkspaceNextOptionalParams	Optional parameters.
PrivateLinkResourcesListByWorkspaceOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegistrationInfo	Represents a RegistrationInfo definition.
RegistrationInfoPatch	Represents a RegistrationInfo definition.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceModelWithAllowedPropertySet	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.
ResourceModelWithAllowedPropertySetIdentity	Identity for the resource.
ResourceModelWithAllowedPropertySetPlan	Plan for the resource.
ResourceModelWithAllowedPropertySetSku	The resource model definition representing SKU
ResourceProviderOperation	Supported operation of this resource provider.
ResourceProviderOperationDisplay	Display metadata associated with the operation.
ResourceProviderOperationList	Result of the request to list operations.
ScalingHostPoolReference	Scaling plan reference to hostpool.
ScalingPlan	Represents a scaling plan definition.
ScalingPlanList	List of scaling plan definitions.
ScalingPlanPatch	Scaling plan properties that can be patched.
ScalingPlanPersonalSchedule	Represents a ScalingPlanPersonalSchedule definition.
ScalingPlanPersonalScheduleList	List of ScalingPlanPersonalSchedule definitions.
ScalingPlanPersonalSchedulePatch	ScalingPlanPersonalSchedule properties that can be patched.
ScalingPlanPersonalSchedules	Interface representing a ScalingPlanPersonalSchedules.
ScalingPlanPersonalSchedulesCreateOptionalParams	Optional parameters.
ScalingPlanPersonalSchedulesDeleteOptionalParams	Optional parameters.
ScalingPlanPersonalSchedulesGetOptionalParams	Optional parameters.
ScalingPlanPersonalSchedulesListNextOptionalParams	Optional parameters.
ScalingPlanPersonalSchedulesListOptionalParams	Optional parameters.
ScalingPlanPersonalSchedulesUpdateOptionalParams	Optional parameters.
ScalingPlanPooledSchedule	Represents a ScalingPlanPooledSchedule definition.
ScalingPlanPooledScheduleList	List of ScalingPlanPooledSchedule definitions.
ScalingPlanPooledSchedulePatch	ScalingPlanPooledSchedule properties that can be patched.
ScalingPlanPooledSchedules	Interface representing a ScalingPlanPooledSchedules.
ScalingPlanPooledSchedulesCreateOptionalParams	Optional parameters.
ScalingPlanPooledSchedulesDeleteOptionalParams	Optional parameters.
ScalingPlanPooledSchedulesGetOptionalParams	Optional parameters.
ScalingPlanPooledSchedulesListNextOptionalParams	Optional parameters.
ScalingPlanPooledSchedulesListOptionalParams	Optional parameters.
ScalingPlanPooledSchedulesUpdateOptionalParams	Optional parameters.
ScalingPlans	Interface representing a ScalingPlans.
ScalingPlansCreateOptionalParams	Optional parameters.
ScalingPlansDeleteOptionalParams	Optional parameters.
ScalingPlansGetOptionalParams	Optional parameters.
ScalingPlansListByHostPoolNextOptionalParams	Optional parameters.
ScalingPlansListByHostPoolOptionalParams	Optional parameters.
ScalingPlansListByResourceGroupNextOptionalParams	Optional parameters.
ScalingPlansListByResourceGroupOptionalParams	Optional parameters.
ScalingPlansListBySubscriptionNextOptionalParams	Optional parameters.
ScalingPlansListBySubscriptionOptionalParams	Optional parameters.
ScalingPlansUpdateOptionalParams	Optional parameters.
ScalingSchedule	A ScalingPlanPooledSchedule.
SendMessage	Represents message sent to a UserSession.
ServiceSpecification	Service specification payload
SessionHost	Represents a SessionHost definition.
SessionHostHealthCheckFailureDetails	Contains details on the failure.
SessionHostHealthCheckReport	The report for session host information.
SessionHostList	List of SessionHost definitions.
SessionHostPatch	SessionHost properties that can be patched.
SessionHosts	Interface representing a SessionHosts.
SessionHostsDeleteOptionalParams	Optional parameters.
SessionHostsGetOptionalParams	Optional parameters.
SessionHostsListNextOptionalParams	Optional parameters.
SessionHostsListOptionalParams	Optional parameters.
SessionHostsUpdateOptionalParams	Optional parameters.
Sku	The resource model definition representing SKU
StartMenuItem	Represents a StartMenuItem definition.
StartMenuItemList	List of StartMenuItem definitions.
StartMenuItems	Interface representing a StartMenuItems.
StartMenuItemsListNextOptionalParams	Optional parameters.
StartMenuItemsListOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
Time	The time for a scaling action to occur.
UserSession	Represents a UserSession definition.
UserSessionList	List of UserSession definitions.
UserSessions	Interface representing a UserSessions.
UserSessionsDeleteOptionalParams	Optional parameters.
UserSessionsDisconnectOptionalParams	Optional parameters.
UserSessionsGetOptionalParams	Optional parameters.
UserSessionsListByHostPoolNextOptionalParams	Optional parameters.
UserSessionsListByHostPoolOptionalParams	Optional parameters.
UserSessionsListNextOptionalParams	Optional parameters.
UserSessionsListOptionalParams	Optional parameters.
UserSessionsSendMessageOptionalParams	Optional parameters.
Workspace	Represents a Workspace definition.
WorkspaceList	List of Workspace definitions.
WorkspacePatch	Workspace properties that can be patched.
Workspaces	Interface representing a Workspaces.
WorkspacesCreateOrUpdateOptionalParams	Optional parameters.
WorkspacesDeleteOptionalParams	Optional parameters.
WorkspacesGetOptionalParams	Optional parameters.
WorkspacesListByResourceGroupNextOptionalParams	Optional parameters.
WorkspacesListByResourceGroupOptionalParams	Optional parameters.
WorkspacesListBySubscriptionNextOptionalParams	Optional parameters.
WorkspacesListBySubscriptionOptionalParams	Optional parameters.
WorkspacesUpdateOptionalParams	Optional parameters.

Type Aliases

ApplicationGroupType	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
ApplicationGroupsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ApplicationGroupsGetResponse	Contains response data for the get operation.
ApplicationGroupsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ApplicationGroupsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ApplicationGroupsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ApplicationGroupsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ApplicationGroupsUpdateResponse	Contains response data for the update operation.
ApplicationType	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
ApplicationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ApplicationsGetResponse	Contains response data for the get operation.
ApplicationsListNextResponse	Contains response data for the listNext operation.
ApplicationsListResponse	Contains response data for the list operation.
ApplicationsUpdateResponse	Contains response data for the update operation.
CommandLineSetting	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
CreatedByType	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
DayOfWeek	Defines values for DayOfWeek.
DesktopsGetResponse	Contains response data for the get operation.
DesktopsListNextResponse	Contains response data for the listNext operation.
DesktopsListResponse	Contains response data for the list operation.
DesktopsUpdateResponse	Contains response data for the update operation.
HealthCheckName	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)
HealthCheckResult	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.
HostPoolType	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.
HostPoolsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
HostPoolsGetResponse	Contains response data for the get operation.
HostPoolsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
HostPoolsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
HostPoolsListNextResponse	Contains response data for the listNext operation.
HostPoolsListResponse	Contains response data for the list operation.
HostPoolsRetrieveRegistrationTokenResponse	Contains response data for the retrieveRegistrationToken operation.
HostPoolsUpdateResponse	Contains response data for the update operation.
HostpoolPublicNetworkAccess	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
LoadBalancerType	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
MsixImagesExpandNextResponse	Contains response data for the expandNext operation.
MsixImagesExpandResponse	Contains response data for the expand operation.
MsixPackagesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
MsixPackagesGetResponse	Contains response data for the get operation.
MsixPackagesListNextResponse	Contains response data for the listNext operation.
MsixPackagesListResponse	Contains response data for the list operation.
MsixPackagesUpdateResponse	Contains response data for the update operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PersonalDesktopAssignmentType	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
PreferredAppGroupType	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
PrivateEndpointConnectionProvisioningState	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
PrivateEndpointConnectionsGetByHostPoolResponse	Contains response data for the getByHostPool operation.
PrivateEndpointConnectionsGetByWorkspaceResponse	Contains response data for the getByWorkspace operation.
PrivateEndpointConnectionsListByHostPoolNextResponse	Contains response data for the listByHostPoolNext operation.
PrivateEndpointConnectionsListByHostPoolResponse	Contains response data for the listByHostPool operation.
PrivateEndpointConnectionsListByWorkspaceNextResponse	Contains response data for the listByWorkspaceNext operation.
PrivateEndpointConnectionsListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
PrivateEndpointConnectionsUpdateByHostPoolResponse	Contains response data for the updateByHostPool operation.
PrivateEndpointConnectionsUpdateByWorkspaceResponse	Contains response data for the updateByWorkspace operation.
PrivateEndpointServiceConnectionStatus	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
PrivateLinkResourcesListByHostPoolNextResponse	Contains response data for the listByHostPoolNext operation.
PrivateLinkResourcesListByHostPoolResponse	Contains response data for the listByHostPool operation.
PrivateLinkResourcesListByWorkspaceNextResponse	Contains response data for the listByWorkspaceNext operation.
PrivateLinkResourcesListByWorkspaceResponse	Contains response data for the listByWorkspace operation.
PublicNetworkAccess	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
RegistrationTokenOperation	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
RemoteApplicationType	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
SSOSecretType	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
ScalingHostPoolType	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.
ScalingPlanPersonalSchedulesCreateResponse	Contains response data for the create operation.
ScalingPlanPersonalSchedulesGetResponse	Contains response data for the get operation.
ScalingPlanPersonalSchedulesListNextResponse	Contains response data for the listNext operation.
ScalingPlanPersonalSchedulesListResponse	Contains response data for the list operation.
ScalingPlanPersonalSchedulesUpdateResponse	Contains response data for the update operation.
ScalingPlanPooledSchedulesCreateResponse	Contains response data for the create operation.
ScalingPlanPooledSchedulesGetResponse	Contains response data for the get operation.
ScalingPlanPooledSchedulesListNextResponse	Contains response data for the listNext operation.
ScalingPlanPooledSchedulesListResponse	Contains response data for the list operation.
ScalingPlanPooledSchedulesUpdateResponse	Contains response data for the update operation.
ScalingPlansCreateResponse	Contains response data for the create operation.
ScalingPlansGetResponse	Contains response data for the get operation.
ScalingPlansListByHostPoolNextResponse	Contains response data for the listByHostPoolNext operation.
ScalingPlansListByHostPoolResponse	Contains response data for the listByHostPool operation.
ScalingPlansListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ScalingPlansListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ScalingPlansListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ScalingPlansListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ScalingPlansUpdateResponse	Contains response data for the update operation.
ScalingScheduleDaysOfWeekItem	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
SessionHandlingOperation	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
SessionHostComponentUpdateType	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.
SessionHostLoadBalancingAlgorithm	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
SessionHostsGetResponse	Contains response data for the get operation.
SessionHostsListNextResponse	Contains response data for the listNext operation.
SessionHostsListResponse	Contains response data for the list operation.
SessionHostsUpdateResponse	Contains response data for the update operation.
SessionState	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
SetStartVMOnConnect	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
SkuTier	Defines values for SkuTier.
StartMenuItemsListNextResponse	Contains response data for the listNext operation.
StartMenuItemsListResponse	Contains response data for the list operation.
StartupBehavior	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.
Status	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.
StopHostsWhen	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
UpdateState	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
UserSessionsGetResponse	Contains response data for the get operation.
UserSessionsListByHostPoolNextResponse	Contains response data for the listByHostPoolNext operation.
UserSessionsListByHostPoolResponse	Contains response data for the listByHostPool operation.
UserSessionsListNextResponse	Contains response data for the listNext operation.
UserSessionsListResponse	Contains response data for the list operation.
WorkspacesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WorkspacesGetResponse	Contains response data for the get operation.
WorkspacesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
WorkspacesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
WorkspacesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
WorkspacesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
WorkspacesUpdateResponse	Contains response data for the update operation.

Enums

KnownApplicationGroupType	Known values of ApplicationGroupType that the service accepts.
KnownApplicationType	Known values of ApplicationType that the service accepts.
KnownCommandLineSetting	Known values of CommandLineSetting that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownHealthCheckName	Known values of HealthCheckName that the service accepts.
KnownHealthCheckResult	Known values of HealthCheckResult that the service accepts.
KnownHostPoolType	Known values of HostPoolType that the service accepts.
KnownHostpoolPublicNetworkAccess	Known values of HostpoolPublicNetworkAccess that the service accepts.
KnownLoadBalancerType	Known values of LoadBalancerType that the service accepts.
KnownPersonalDesktopAssignmentType	Known values of PersonalDesktopAssignmentType that the service accepts.
KnownPreferredAppGroupType	Known values of PreferredAppGroupType that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownRegistrationTokenOperation	Known values of RegistrationTokenOperation that the service accepts.
KnownRemoteApplicationType	Known values of RemoteApplicationType that the service accepts.
KnownSSOSecretType	Known values of SSOSecretType that the service accepts.
KnownScalingHostPoolType	Known values of ScalingHostPoolType that the service accepts.
KnownScalingScheduleDaysOfWeekItem	Known values of ScalingScheduleDaysOfWeekItem that the service accepts.
KnownSessionHandlingOperation	Known values of SessionHandlingOperation that the service accepts.
KnownSessionHostComponentUpdateType	Known values of SessionHostComponentUpdateType that the service accepts.
KnownSessionHostLoadBalancingAlgorithm	Known values of SessionHostLoadBalancingAlgorithm that the service accepts.
KnownSessionState	Known values of SessionState that the service accepts.
KnownSetStartVMOnConnect	Known values of SetStartVMOnConnect that the service accepts.
KnownStartupBehavior	Known values of StartupBehavior that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownStopHostsWhen	Known values of StopHostsWhen that the service accepts.
KnownUpdateState	Known values of UpdateState that the service accepts.

Functions

getContinuationToken(unknown)

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

Function Details

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.