@azure/arm-desktopvirtualization

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

serializer

Object literals

Type aliases

Application

Application: Resource & { applicationType?: RemoteApplicationType; commandLineArguments?: undefined | string; commandLineSetting: CommandLineSetting; description?: undefined | string; filePath?: undefined | string; friendlyName?: undefined | string; iconContent?: Uint8Array; iconHash?: undefined | string; iconIndex?: undefined | number; iconPath?: undefined | string; msixPackageApplicationId?: undefined | string; msixPackageFamilyName?: undefined | string; objectId?: undefined | string; showInPortal?: undefined | false | true; systemData?: SystemData }

Schema for Application properties.

ApplicationGroup

ApplicationGroup: ResourceModelWithAllowedPropertySet & { applicationGroupType: ApplicationGroupType; cloudPcResource?: undefined | false | true; description?: undefined | string; friendlyName?: undefined | string; hostPoolArmPath: string; migrationRequest?: MigrationRequestProperties; objectId?: undefined | string; systemData?: SystemData; workspaceArmPath?: undefined | string }

Represents a ApplicationGroup definition.

ApplicationGroupPatch

ApplicationGroupPatch: Resource & { description?: undefined | string; friendlyName?: undefined | string; tags?: undefined | {} }

ApplicationGroup properties that can be patched.

ApplicationGroupType

ApplicationGroupType: string

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

ApplicationGroupsCreateOrUpdateResponse: ApplicationGroup

Contains response data for the createOrUpdate operation.

ApplicationGroupsGetResponse

ApplicationGroupsGetResponse: ApplicationGroup

Contains response data for the get operation.

ApplicationGroupsListByResourceGroupNextResponse

ApplicationGroupsListByResourceGroupNextResponse: ApplicationGroupList

Contains response data for the listByResourceGroupNext operation.

ApplicationGroupsListByResourceGroupResponse

ApplicationGroupsListByResourceGroupResponse: ApplicationGroupList

Contains response data for the listByResourceGroup operation.

ApplicationGroupsListBySubscriptionNextResponse

ApplicationGroupsListBySubscriptionNextResponse: ApplicationGroupList

Contains response data for the listBySubscriptionNext operation.

ApplicationGroupsListBySubscriptionResponse

ApplicationGroupsListBySubscriptionResponse: ApplicationGroupList

Contains response data for the listBySubscription operation.

ApplicationGroupsUpdateResponse

ApplicationGroupsUpdateResponse: ApplicationGroup

Contains response data for the update operation.

ApplicationType

ApplicationType: string

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

ApplicationsCreateOrUpdateResponse: Application

Contains response data for the createOrUpdate operation.

ApplicationsGetResponse

ApplicationsGetResponse: Application

Contains response data for the get operation.

ApplicationsListNextResponse

ApplicationsListNextResponse: ApplicationList

Contains response data for the listNext operation.

ApplicationsListResponse

ApplicationsListResponse: ApplicationList

Contains response data for the list operation.

ApplicationsUpdateResponse

ApplicationsUpdateResponse: Application

Contains response data for the update operation.

CommandLineSetting

CommandLineSetting: string

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

CreatedByType: string

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

Desktop

Desktop: Resource & { description?: undefined | string; friendlyName?: undefined | string; iconContent?: Uint8Array; iconHash?: undefined | string; objectId?: undefined | string; systemData?: SystemData }

Schema for Desktop properties.

DesktopsGetResponse

DesktopsGetResponse: Desktop

Contains response data for the get operation.

DesktopsListNextResponse

DesktopsListNextResponse: DesktopList

Contains response data for the listNext operation.

DesktopsListResponse

DesktopsListResponse: DesktopList

Contains response data for the list operation.

DesktopsUpdateResponse

DesktopsUpdateResponse: Desktop

Contains response data for the update operation.

ExpandMsixImage

ExpandMsixImage: Resource & { displayName?: undefined | string; imagePath?: undefined | string; isActive?: undefined | false | true; isRegularRegistration?: undefined | false | true; lastUpdated?: Date; packageAlias?: undefined | string; packageApplications?: MsixPackageApplications[]; packageDependencies?: MsixPackageDependencies[]; packageFamilyName?: undefined | string; packageFullName?: undefined | string; packageName?: undefined | string; packageRelativePath?: undefined | string; version?: undefined | string }

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

HealthCheckName

HealthCheckName: string

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.
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.
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.
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.
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 ...).
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.
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.
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.
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.
MetaDataServiceCheck: Verifies the metadata service is accessible and return compute properties.
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.

HealthCheckResult

HealthCheckResult: string

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.

HostPool

HostPool: ResourceModelWithAllowedPropertySet & { applicationGroupReferences?: string[]; cloudPcResource?: undefined | false | true; customRdpProperty?: undefined | string; description?: undefined | string; friendlyName?: undefined | string; hostPoolType: HostPoolType; loadBalancerType: LoadBalancerType; maxSessionLimit?: undefined | number; migrationRequest?: MigrationRequestProperties; objectId?: undefined | string; personalDesktopAssignmentType?: PersonalDesktopAssignmentType; preferredAppGroupType: PreferredAppGroupType; publicNetworkAccess?: PublicNetworkAccess; registrationInfo?: RegistrationInfo; ring?: undefined | number; ssoClientId?: undefined | string; ssoClientSecretKeyVaultPath?: undefined | string; ssoSecretType?: SSOSecretType; ssoadfsAuthority?: undefined | string; startVMOnConnect?: undefined | false | true; systemData?: SystemData; validationEnvironment?: undefined | false | true; vmTemplate?: undefined | string }

Represents a HostPool definition.

HostPoolPatch

HostPoolPatch: Resource & { customRdpProperty?: undefined | string; description?: undefined | string; friendlyName?: undefined | string; loadBalancerType?: LoadBalancerType; maxSessionLimit?: undefined | number; personalDesktopAssignmentType?: PersonalDesktopAssignmentType; preferredAppGroupType?: PreferredAppGroupType; publicNetworkAccess?: PublicNetworkAccess; registrationInfo?: RegistrationInfoPatch; ring?: undefined | number; ssoClientId?: undefined | string; ssoClientSecretKeyVaultPath?: undefined | string; ssoSecretType?: SSOSecretType; ssoadfsAuthority?: undefined | string; startVMOnConnect?: undefined | false | true; tags?: undefined | {}; validationEnvironment?: undefined | false | true; vmTemplate?: undefined | string }

HostPool properties that can be patched.

HostPoolType

HostPoolType: string

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

HostPoolsCreateOrUpdateResponse: HostPool

Contains response data for the createOrUpdate operation.

HostPoolsGetResponse

HostPoolsGetResponse: HostPool

Contains response data for the get operation.

HostPoolsListByResourceGroupNextResponse

HostPoolsListByResourceGroupNextResponse: HostPoolList

Contains response data for the listByResourceGroupNext operation.

HostPoolsListByResourceGroupResponse

HostPoolsListByResourceGroupResponse: HostPoolList

Contains response data for the listByResourceGroup operation.

HostPoolsListNextResponse

HostPoolsListNextResponse: HostPoolList

Contains response data for the listNext operation.

HostPoolsListResponse

HostPoolsListResponse: HostPoolList

Contains response data for the list operation.

HostPoolsRetrieveRegistrationTokenResponse

HostPoolsRetrieveRegistrationTokenResponse: RegistrationInfo

Contains response data for the retrieveRegistrationToken operation.

HostPoolsUpdateResponse

HostPoolsUpdateResponse: HostPool

Contains response data for the update operation.

LoadBalancerType

LoadBalancerType: string

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

MsixImagesExpandNextResponse: ExpandMsixImageList

Contains response data for the expandNext operation.

MsixImagesExpandResponse

MsixImagesExpandResponse: ExpandMsixImageList

Contains response data for the expand operation.

MsixPackage

MsixPackage: Resource & { displayName?: undefined | string; imagePath?: undefined | string; isActive?: undefined | false | true; isRegularRegistration?: undefined | false | true; lastUpdated?: Date; packageApplications?: MsixPackageApplications[]; packageDependencies?: MsixPackageDependencies[]; packageFamilyName?: undefined | string; packageName?: undefined | string; packageRelativePath?: undefined | string; systemData?: SystemData; version?: undefined | string }

Schema for MSIX Package properties.

MsixPackagePatch

MsixPackagePatch: Resource & { displayName?: undefined | string; isActive?: undefined | false | true; isRegularRegistration?: undefined | false | true }

MSIX Package properties that can be patched.

MsixPackagesCreateOrUpdateResponse

MsixPackagesCreateOrUpdateResponse: MsixPackage

Contains response data for the createOrUpdate operation.

MsixPackagesGetResponse

MsixPackagesGetResponse: MsixPackage

Contains response data for the get operation.

MsixPackagesListNextResponse

MsixPackagesListNextResponse: MsixPackageList

Contains response data for the listNext operation.

MsixPackagesListResponse

MsixPackagesListResponse: MsixPackageList

Contains response data for the list operation.

MsixPackagesUpdateResponse

MsixPackagesUpdateResponse: MsixPackage

Contains response data for the update operation.

Operation

Operation: string

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

Known values supported by the service

Start: Start the migration.
Revoke: Revoke the migration.
Complete: Complete the migration.
Hide: Hide the hostpool.
Unhide: Unhide the hostpool.

OperationsListNextResponse

OperationsListNextResponse: ResourceProviderOperationList

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: ResourceProviderOperationList

Contains response data for the list operation.

PersonalDesktopAssignmentType

PersonalDesktopAssignmentType: string

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

PreferredAppGroupType: string

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

PrivateEndpointConnection

PrivateEndpointConnection: Resource & { privateEndpoint?: PrivateEndpoint; privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState; provisioningState?: PrivateEndpointConnectionProvisioningState }

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

PrivateEndpointConnectionProvisioningState: string

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

PrivateEndpointConnectionWithSystemData

PrivateEndpointConnectionWithSystemData: PrivateEndpointConnection & { systemData?: SystemData }

The Private Endpoint Connection resource.

PrivateEndpointConnectionsGetByHostPoolResponse

PrivateEndpointConnectionsGetByHostPoolResponse: PrivateEndpointConnectionWithSystemData

Contains response data for the getByHostPool operation.

PrivateEndpointConnectionsGetByWorkspaceResponse

PrivateEndpointConnectionsGetByWorkspaceResponse: PrivateEndpointConnectionWithSystemData

Contains response data for the getByWorkspace operation.

PrivateEndpointConnectionsListByHostPoolNextResponse

PrivateEndpointConnectionsListByHostPoolNextResponse: PrivateEndpointConnectionListResultWithSystemData

Contains response data for the listByHostPoolNext operation.

PrivateEndpointConnectionsListByHostPoolResponse

PrivateEndpointConnectionsListByHostPoolResponse: PrivateEndpointConnectionListResultWithSystemData

Contains response data for the listByHostPool operation.

PrivateEndpointConnectionsListByWorkspaceNextResponse

PrivateEndpointConnectionsListByWorkspaceNextResponse: PrivateEndpointConnectionListResultWithSystemData

Contains response data for the listByWorkspaceNext operation.

PrivateEndpointConnectionsListByWorkspaceResponse

PrivateEndpointConnectionsListByWorkspaceResponse: PrivateEndpointConnectionListResultWithSystemData

Contains response data for the listByWorkspace operation.

PrivateEndpointConnectionsUpdateByHostPoolResponse

PrivateEndpointConnectionsUpdateByHostPoolResponse: PrivateEndpointConnectionWithSystemData

Contains response data for the updateByHostPool operation.

PrivateEndpointConnectionsUpdateByWorkspaceResponse

PrivateEndpointConnectionsUpdateByWorkspaceResponse: PrivateEndpointConnectionWithSystemData

Contains response data for the updateByWorkspace operation.

PrivateEndpointServiceConnectionStatus

PrivateEndpointServiceConnectionStatus: string

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

PrivateLinkResource

PrivateLinkResource: Resource & { groupId?: undefined | string; requiredMembers?: string[]; requiredZoneNames?: string[] }

A private link resource

PrivateLinkResourcesListByHostPoolNextResponse

PrivateLinkResourcesListByHostPoolNextResponse: PrivateLinkResourceListResult

Contains response data for the listByHostPoolNext operation.

PrivateLinkResourcesListByHostPoolResponse

PrivateLinkResourcesListByHostPoolResponse: PrivateLinkResourceListResult

Contains response data for the listByHostPool operation.

PrivateLinkResourcesListByWorkspaceNextResponse

PrivateLinkResourcesListByWorkspaceNextResponse: PrivateLinkResourceListResult

Contains response data for the listByWorkspaceNext operation.

PrivateLinkResourcesListByWorkspaceResponse

PrivateLinkResourcesListByWorkspaceResponse: PrivateLinkResourceListResult

Contains response data for the listByWorkspace operation.

PublicNetworkAccess

PublicNetworkAccess: string

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

RegistrationTokenOperation: string

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

RemoteApplicationType: string

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

ResourceModelWithAllowedPropertySetIdentity

ResourceModelWithAllowedPropertySetIdentity: Identity & {}

ResourceModelWithAllowedPropertySetPlan

ResourceModelWithAllowedPropertySetPlan: Plan & {}

ResourceModelWithAllowedPropertySetSku

ResourceModelWithAllowedPropertySetSku: Sku & {}

SSOSecretType

SSOSecretType: string

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

ScalingHostPoolType: string

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.

ScalingPlan

ScalingPlan: ResourceModelWithAllowedPropertySet & { description?: undefined | string; exclusionTag?: undefined | string; friendlyName?: undefined | string; hostPoolReferences?: ScalingHostPoolReference[]; hostPoolType?: ScalingHostPoolType; objectId?: undefined | string; schedules?: ScalingSchedule[]; systemData?: SystemData; timeZone?: undefined | string }

Represents a scaling plan definition.

ScalingPlansCreateResponse

ScalingPlansCreateResponse: ScalingPlan

Contains response data for the create operation.

ScalingPlansGetResponse

ScalingPlansGetResponse: ScalingPlan

Contains response data for the get operation.

ScalingPlansListByHostPoolNextResponse

ScalingPlansListByHostPoolNextResponse: ScalingPlanList

Contains response data for the listByHostPoolNext operation.

ScalingPlansListByHostPoolResponse

ScalingPlansListByHostPoolResponse: ScalingPlanList

Contains response data for the listByHostPool operation.

ScalingPlansListByResourceGroupNextResponse

ScalingPlansListByResourceGroupNextResponse: ScalingPlanList

Contains response data for the listByResourceGroupNext operation.

ScalingPlansListByResourceGroupResponse

ScalingPlansListByResourceGroupResponse: ScalingPlanList

Contains response data for the listByResourceGroup operation.

ScalingPlansListBySubscriptionNextResponse

ScalingPlansListBySubscriptionNextResponse: ScalingPlanList

Contains response data for the listBySubscriptionNext operation.

ScalingPlansListBySubscriptionResponse

ScalingPlansListBySubscriptionResponse: ScalingPlanList

Contains response data for the listBySubscription operation.

ScalingPlansUpdateResponse

ScalingPlansUpdateResponse: ScalingPlan

Contains response data for the update operation.

ScalingScheduleDaysOfWeekItem

ScalingScheduleDaysOfWeekItem: string

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

SessionHost

SessionHost: Resource & { agentVersion?: undefined | string; allowNewSession?: undefined | false | true; assignedUser?: undefined | string; lastHeartBeat?: Date; lastUpdateTime?: Date; objectId?: undefined | string; osVersion?: undefined | string; resourceId?: undefined | string; sessionHostHealthCheckResults?: SessionHostHealthCheckReport[]; sessions?: undefined | number; status?: Status; statusTimestamp?: Date; sxSStackVersion?: undefined | string; systemData?: SystemData; updateErrorMessage?: undefined | string; updateState?: UpdateState; virtualMachineId?: undefined | string }

Represents a SessionHost definition.

SessionHostLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm: string

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

SessionHostPatch

SessionHostPatch: Resource & { allowNewSession?: undefined | false | true; assignedUser?: undefined | string }

SessionHost properties that can be patched.

SessionHostsGetResponse

SessionHostsGetResponse: SessionHost

Contains response data for the get operation.

SessionHostsListNextResponse

SessionHostsListNextResponse: SessionHostList

Contains response data for the listNext operation.

SessionHostsListResponse

SessionHostsListResponse: SessionHostList

Contains response data for the list operation.

SessionHostsUpdateResponse

SessionHostsUpdateResponse: SessionHost

Contains response data for the update operation.

SessionState

SessionState: string

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

SkuTier

SkuTier: "Free" | "Basic" | "Standard" | "Premium"

Defines values for SkuTier.

StartMenuItem

StartMenuItem: Resource & { appAlias?: undefined | string; commandLineArguments?: undefined | string; filePath?: undefined | string; iconIndex?: undefined | number; iconPath?: undefined | string }

Represents a StartMenuItem definition.

StartMenuItemsListNextResponse

StartMenuItemsListNextResponse: StartMenuItemList

Contains response data for the listNext operation.

StartMenuItemsListResponse

StartMenuItemsListResponse: StartMenuItemList

Contains response data for the list operation.

Status

Status: string

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

StopHostsWhen: string

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

UpdateState: string

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

UserSession

UserSession: Resource & { activeDirectoryUserName?: undefined | string; applicationType?: ApplicationType; createTime?: Date; objectId?: undefined | string; sessionState?: SessionState; systemData?: SystemData; userPrincipalName?: undefined | string }

Represents a UserSession definition.

UserSessionsGetResponse

UserSessionsGetResponse: UserSession

Contains response data for the get operation.

UserSessionsListByHostPoolNextResponse

UserSessionsListByHostPoolNextResponse: UserSessionList

Contains response data for the listByHostPoolNext operation.

UserSessionsListByHostPoolResponse

UserSessionsListByHostPoolResponse: UserSessionList

Contains response data for the listByHostPool operation.

UserSessionsListNextResponse

UserSessionsListNextResponse: UserSessionList

Contains response data for the listNext operation.

UserSessionsListResponse

UserSessionsListResponse: UserSessionList

Contains response data for the list operation.

Workspace

Workspace: ResourceModelWithAllowedPropertySet & { applicationGroupReferences?: string[]; cloudPcResource?: undefined | false | true; description?: undefined | string; friendlyName?: undefined | string; objectId?: undefined | string; publicNetworkAccess?: PublicNetworkAccess; systemData?: SystemData }

Represents a Workspace definition.

WorkspacesCreateOrUpdateResponse

WorkspacesCreateOrUpdateResponse: Workspace

Contains response data for the createOrUpdate operation.

WorkspacesGetResponse

WorkspacesGetResponse: Workspace

Contains response data for the get operation.

WorkspacesListByResourceGroupNextResponse

WorkspacesListByResourceGroupNextResponse: WorkspaceList

Contains response data for the listByResourceGroupNext operation.

WorkspacesListByResourceGroupResponse

WorkspacesListByResourceGroupResponse: WorkspaceList

Contains response data for the listByResourceGroup operation.

WorkspacesListBySubscriptionNextResponse

WorkspacesListBySubscriptionNextResponse: WorkspaceList

Contains response data for the listBySubscriptionNext operation.

WorkspacesListBySubscriptionResponse

WorkspacesListBySubscriptionResponse: WorkspaceList

Contains response data for the listBySubscription operation.

WorkspacesUpdateResponse

WorkspacesUpdateResponse: Workspace

Contains response data for the update operation.

Variables

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

Const Application

Application: object

type

type: object

className

className: string = "Application"

name

modelProperties

modelProperties: object

applicationType

applicationType: object

serializedName

serializedName: string = "properties.applicationType"

type

type: object

name

commandLineArguments

commandLineArguments: object

serializedName

serializedName: string = "properties.commandLineArguments"

type

type: object

name

commandLineSetting

type

type: object

name

iconHash

type: object

className

className: string = "ApplicationGroupList"

name

modelProperties

modelProperties: object

nextLink

type

type: object

name

friendlyName

friendlyName: object

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

tags

className

className: string = "ApplicationList"

name

modelProperties

modelProperties: object

nextLink

serializedName

serializedName: string = "properties.msixPackageApplicationId"

type

type: object

name

msixPackageFamilyName

className

className: string = "CloudError"

name

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CloudErrorProperties"

name

Const CloudErrorProperties

CloudErrorProperties: object

type

type: object

className

className: string = "CloudErrorProperties"

name

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

serializedName

serializedName: string = "properties.description"

type

type: object

DesktopList: object

type

type: object

className

className: string = "DesktopList"

name

modelProperties

modelProperties: object

nextLink

type

type: object

name

friendlyName

friendlyName: object

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

tags

className

className: string = "ExpandMsixImage"

name

modelProperties

modelProperties: object

displayName

serializedName: string = "properties.applicationGroupReferences"

type

type: object

name

element

element: object

type

type: object

name

cloudPcResource

type

type: object

name

loadBalancerType

className

className: string = "MigrationRequestProperties"

name

objectId

type

type: object

name

publicNetworkAccess

publicNetworkAccess: object

serializedName

serializedName: string = "properties.publicNetworkAccess"

type

type: object

name

registrationInfo

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

serializedName: string = "uri"

type

type: object

name

Const MsixPackage

MsixPackage: object

type

type: object

className

className: string = "MsixPackage"

name

modelProperties

modelProperties: object

displayName

serializedName

serializedName: string = "serviceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

Const Plan

Plan: object

type

type: object

className

className: string = "Plan"

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

product

type: object

className

className: string = "PrivateEndpoint"

name

privateLinkServiceConnectionState

privateLinkServiceConnectionState: object

serializedName

serializedName: string = "properties.privateLinkServiceConnectionState"

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

Const PrivateEndpointConnectionListResultWithSystemData

PrivateEndpointConnectionListResultWithSystemData: object

type

type: object

className

className: string = "PrivateEndpointConnectionListResultWithSystemData"

name

modelProperties

modelProperties: object

nextLink

type

type: object

className

className: string = "SystemData"

name

Const PrivateLinkResource

PrivateLinkResource: object

type

type: object

className

className: string = "PrivateLinkResource"

name

modelProperties

modelProperties: object

groupId

groupId: object

readOnly

element: object

type

type: object

name

Const PrivateLinkResourceListResult

PrivateLinkResourceListResult: object

type

type: object

className

className: string = "PrivateLinkResourceListResult"

name

modelProperties

modelProperties: object

nextLink

type: object

type

type: object

name

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

managedBy

managedBy: object

serializedName

serializedName: string = "managedBy"

type

type: object

serializedName

serializedName: string = "name"

type

type: object

name

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "OperationProperties"

name

Const ResourceProviderOperationDisplay

ResourceProviderOperationDisplay: object

type

type: object

className

className: string = "ResourceProviderOperationDisplay"

name

modelProperties

nextLink

type

type: object

name

element

element: object

type

type: object

type: object

className

className: string = "Time"

name

rampDownCapacityThresholdPct

rampDownCapacityThresholdPct: object

serializedName

serializedName: string = "rampDownCapacityThresholdPct"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

rampDownForceLogoffUsers

rampDownForceLogoffUsers: object

serializedName

serializedName: string = "rampDownForceLogoffUsers"

type

type: object

name

rampDownLoadBalancingAlgorithm

rampDownLoadBalancingAlgorithm: object

serializedName

serializedName: string = "rampDownLoadBalancingAlgorithm"

type

type: object

name

rampDownMinimumHostsPct

rampDownMinimumHostsPct: object

serializedName

serializedName: string = "rampDownMinimumHostsPct"

constraints

constraints: object

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

rampUpLoadBalancingAlgorithm

rampUpLoadBalancingAlgorithm: object

serializedName

serializedName: string = "rampUpLoadBalancingAlgorithm"

type

type: object

name

rampUpMinimumHostsPct

rampUpMinimumHostsPct: object

serializedName

serializedName: string = "rampUpMinimumHostsPct"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

rampUpStartTime

rampUpStartTime: object

serializedName

serializedName: string = "rampUpStartTime"

type

type: object

className

className: string = "Time"

name

Const SendMessage

SendMessage: object

type

type: object

className

className: string = "SendMessage"

name

modelProperties

modelProperties: object

messageBody

messageBody: object

serializedName

serializedName: string = "messageBody"

type

type: object

name

objectId

type

type: object

name

sessionHostHealthCheckResults

type

type: object

name

sxSStackVersion

sxSStackVersion: object

serializedName

serializedName: string = "properties.sxSStackVersion"

type

type: object

name

systemData

serializedName

serializedName: string = "capacity"

type

type: object

name

family

family: object

serializedName

serializedName: string = "family"

type

type: object

type: object

allowedValues

allowedValues: string[] = ["Free", "Basic", "Standard", "Premium"]

name

Const StartMenuItem

StartMenuItem: object

type

type: object

className

className: string = "StartMenuItem"

name

modelProperties

serializedName

serializedName: string = "hour"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 23

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

minute

minute: object

required

required: boolean = true

serializedName

serializedName: string = "minute"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 59

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const UserSession

UserSession: object

type

type: object

className

className: string = "UserSession"

name

modelProperties

modelProperties: object

activeDirectoryUserName

activeDirectoryUserName: object

serializedName

serializedName: string = "properties.activeDirectoryUserName"

serializedName

serializedName: string = "properties.objectId"

type

type: object

name

sessionState

sessionState: object

serializedName

serializedName: string = "properties.sessionState"

type

type: object

name

systemData

systemData: object

serializedName

serializedName: string = "systemData"

type

type: object

className

className: string = "SystemData"

name

userPrincipalName

userPrincipalName: object

serializedName

serializedName: string = "properties.userPrincipalName"

type

type: object

name

Const UserSessionList

UserSessionList: object

type

type: object

className

className: string = "UserSessionList"

name

modelProperties

modelProperties: object

nextLink

type

type: object

name

element

element: object

type

type: object

name

cloudPcResource

type

type: object

name

publicNetworkAccess

publicNetworkAccess: object

serializedName

serializedName: string = "properties.publicNetworkAccess"

type

type: object

type

type: object

value: object

type

type: object

name

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-09-03-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

MinLength: number = 3

type

type: object

name

Const applicationName

applicationName: object

parameterPath

parameterPath: string = "applicationName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "applicationName"

constraints

constraints: object

MaxLength

MaxLength: number = 24

MinLength

MinLength: number = 3

type

type: object

name

Const connection

connection: object

mapper

mapper: any = PrivateEndpointConnectionMapper

parameterPath

parameterPath: string = "connection"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const deleteByWorkspaceOperationSpec

deleteByWorkspaceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.workspaceName,Parameters.privateEndpointConnectionName]

responses

responses: object

200

200: {}

Type declaration

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const deleteOperationSpec

deleteOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.msixPackageFullName]

responses

responses: object

200

200: {}

Type declaration

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const desktop

desktop: object

mapper

mapper: any = DesktopPatchMapper

parameterPath

parameterPath: string[] = ["options", "desktop"]

Const desktopName

desktopName: object

parameterPath

parameterPath: string = "desktopName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "desktopName"

constraints

constraints: object

MaxLength

MaxLength: number = 24

MinLength

MinLength: number = 3

type

type: object

name

Const disconnectOperationSpec

disconnectOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.sessionHostName,Parameters.userSessionId]

responses

responses: object

200

200: {}

filter: object

parameterPath

parameterPath: string[] = ["options", "filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

Const force

force: object

parameterPath

parameterPath: string[] = ["options", "force"]

mapper

mapper: object

serializedName

serializedName: string = "force"

type

type: object

name

Const getByHostPoolOperationSpec

getByHostPoolOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.privateEndpointConnectionName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnectionWithSystemData

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const getByWorkspaceOperationSpec

getByWorkspaceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.workspaceName,Parameters.privateEndpointConnectionName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnectionWithSystemData

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.msixPackageFullName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.MsixPackage

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const hostPool

hostPool: object

mapper

mapper: any = HostPoolMapper

parameterPath

parameterPath: string = "hostPool"

Const hostPool1

hostPool1: object

mapper

mapper: any = HostPoolPatchMapper

parameterPath

parameterPath: string[] = ["options", "hostPool"]

Const hostPoolName

hostPoolName: object

parameterPath

parameterPath: string = "hostPoolName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "hostPoolName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 3

type

type: object

required: boolean = true

serializedName

serializedName: string = "msixPackageFullName"

constraints

constraints: object

MaxLength

MaxLength: number = 100

MinLength

MinLength: number = 3

type

type: object

name

Const nextLink

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

type

type: object

name

Const retrieveRegistrationTokenOperationSpec

retrieveRegistrationTokenOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RegistrationInfo

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const scalingPlan

scalingPlan: object

mapper

mapper: any = ScalingPlanMapper

parameterPath

parameterPath: string = "scalingPlan"

Const scalingPlan1

scalingPlan1: object

mapper

mapper: any = ScalingPlanPatchMapper

parameterPath

parameterPath: string[] = ["options", "scalingPlan"]

Const scalingPlanName

scalingPlanName: object

parameterPath

parameterPath: string = "scalingPlanName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "scalingPlanName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 3

type

type: object

name

Const sendMessage

sendMessage: object

mapper

mapper: any = SendMessageMapper

parameterPath

parameterPath: string[] = ["options", "sendMessage"]

Const sendMessageOperationSpec

sendMessageOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.sendMessage

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.sessionHostName,Parameters.userSessionId]

responses

responses: object

200

200: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const sessionHost

sessionHost: object

mapper

mapper: any = SessionHostPatchMapper

parameterPath

parameterPath: string[] = ["options", "sessionHost"]

Const sessionHostName

sessionHostName: object

parameterPath

parameterPath: string = "sessionHostName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "sessionHostName"

constraints

constraints: object

MaxLength

MaxLength: number = 48

MinLength

MinLength: number = 3

type

type: object

name

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

Const updateByHostPoolOperationSpec

updateByHostPoolOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.connection

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.hostPoolName,Parameters.privateEndpointConnectionName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnectionWithSystemData

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const updateByWorkspaceOperationSpec

updateByWorkspaceOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

serializedName: string = "userSessionId"

constraints

constraints: object

MaxLength

MaxLength: number = 24

MinLength

MinLength: number = 1

type

type: object

type: object

name