Microsoft.DesktopVirtualization (preview:2019-12-10)

2025/08/29 • 38 new, 38 deleted methods

Operations_List (new)
Description :  List all of the available operations the Desktop Virtualization resource provider supports.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DesktopVirtualization/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by this resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, in format of {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider: Microsoft Desktop Virtualization. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of this operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Workspaces_Get (new)
Description :  Get a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_CreateOrUpdate (new)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
workspace:
{
Description: Object containing Workspace definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_Delete (new)
Description :  Remove a workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_Update (new)
Description :  Update a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
workspace:
{
Description: Object containing Workspace definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_ListByResourceGroup (new)
Description :  List workspaces.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_ListBySubscription (new)
Description :  List workspaces in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Get (new)
Description :  Get an application group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_CreateOrUpdate (new)
Description :  Create or update an applicationGroup.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationGroup:
{
Description: Object containing ApplicationGroup definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Delete (new)
Description :  Remove an applicationGroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Update (new)
Description :  Update an applicationGroup.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationGroup:
{
Description: Object containing ApplicationGroup definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: ApplicationGroup properties that can be patched. ,
Required: False ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_ListByResourceGroup (new)
Description :  List applicationGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are applicationGroupType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_ListBySubscription (new)
Description :  List applicationGroups in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are applicationGroupType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
StartMenuItems_List (new)
Description :  List start menu items in the given application group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of StartMenuItem definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for StartMenuItem ,
Required: False ,
}
{
appAlias:
{
Description: Alias of StartMenuItem. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of StartMenuItem. ,
Required: False ,
}
string ,
filePath:
{
Description: Path to the file of StartMenuItem. ,
Required: False ,
}
string ,
commandLineArguments:
{
Description: Command line arguments for StartMenuItem. ,
Required: False ,
}
string ,
iconPath:
{
Description: Path to the icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Get (new)
Description :  Get an application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_CreateOrUpdate (new)
Description :  Create or update an application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
application:
{
Description: Object containing Application definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Delete (new)
Description :  Remove an application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Update (new)
Description :  Update an application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
application:
{
Description: Object containing Application definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Application ,
Required: False ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: False ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_List (new)
Description :  List applications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Application definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_Get (new)
Description :  Get a desktop.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
desktopName:
{
Description: The name of the desktop within the specified desktop group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_Update (new)
Description :  Update a desktop.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
desktopName:
{
Description: The name of the desktop within the specified desktop group ,
Required: True ,
}
string ,
desktop:
{
Description: Object containing Desktop definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_List (new)
Description :  List desktops.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Desktop definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Get (new)
Description :  Get a host pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_CreateOrUpdate (new)
Description :  Create or update a host pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Delete (new)
Description :  Remove a host pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
force:
{
Description: Force flag to delete sessionHost. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Update (new)
Description :  Update a host pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: HostPool properties that can be patched. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_ListByResourceGroup (new)
Description :  List hostPools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_List (new)
Description :  List hostPools in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_ListByHostPool (new)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Get (new)
Description :  Get a session host.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Delete (new)
Description :  Remove a SessionHost.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
force:
{
Description: Force flag to force sessionHost deletion even when userSession exists. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Update (new)
Description :  Update a session host.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
sessionHost:
{
Description: Object containing SessionHost definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_List (new)
Description :  List sessionHosts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SessionHost definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Get (new)
Description :  Get a userSession.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Delete (new)
Description :  Remove a userSession.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
force:
{
Description: Force flag to login off userSession. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_List (new)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Disconnect (new)
Description :  Disconnect a userSession.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_SendMessage (new)
Description :  Send a message to a user.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
sendMessage:
{
Description: Object containing message includes title and message body ,
Required: False ,
}
{
messageTitle:
{
Description: Title of message. ,
Required: False ,
}
string ,
messageBody:
{
Description: Body of message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  List all of the available operations the Desktop Virtualization resource provider supports.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DesktopVirtualization/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by this resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name, in format of {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider: Microsoft Desktop Virtualization. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of this operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Workspaces_Get (removed)
Description :  Get a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_CreateOrUpdate (removed)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
workspace:
{
Description: Object containing Workspace definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_Delete (removed)
Description :  Remove a workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_Update (removed)
Description :  Update a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
workspace:
{
Description: Object containing Workspace definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_ListByResourceGroup (removed)
Description :  List workspaces.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Workspaces_ListBySubscription (removed)
Description :  List workspaces in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
description:
{
Description: Description of Workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Workspace. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Get (removed)
Description :  Get an application group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_CreateOrUpdate (removed)
Description :  Create or update an applicationGroup.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationGroup:
{
Description: Object containing ApplicationGroup definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Delete (removed)
Description :  Remove an applicationGroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_Update (removed)
Description :  Update an applicationGroup.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationGroup:
{
Description: Object containing ApplicationGroup definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: ApplicationGroup properties that can be patched. ,
Required: False ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_ListByResourceGroup (removed)
Description :  List applicationGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are applicationGroupType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplicationGroups_ListBySubscription (removed)
Description :  List applicationGroups in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are applicationGroupType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
description:
{
Description: Description of ApplicationGroup. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of ApplicationGroup. ,
Required: False ,
}
string ,
hostPoolArmPath:
{
Description: HostPool arm path of ApplicationGroup. ,
Required: True ,
}
string ,
workspaceArmPath:
{
Description: Workspace arm path of ApplicationGroup. ,
Required: False ,
}
string ,
applicationGroupType:
{
Description: Resource Type of ApplicationGroup. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
StartMenuItems_List (removed)
Description :  List start menu items in the given application group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of StartMenuItem definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for StartMenuItem ,
Required: False ,
}
{
appAlias:
{
Description: Alias of StartMenuItem. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of StartMenuItem. ,
Required: False ,
}
string ,
filePath:
{
Description: Path to the file of StartMenuItem. ,
Required: False ,
}
string ,
commandLineArguments:
{
Description: Command line arguments for StartMenuItem. ,
Required: False ,
}
string ,
iconPath:
{
Description: Path to the icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Get (removed)
Description :  Get an application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_CreateOrUpdate (removed)
Description :  Create or update an application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
application:
{
Description: Object containing Application definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Delete (removed)
Description :  Remove an application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_Update (removed)
Description :  Update an application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
application:
{
Description: Object containing Application definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Application ,
Required: False ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: False ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Applications_List (removed)
Description :  List applications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Application definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
description:
{
Description: Description of Application. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Application. ,
Required: False ,
}
string ,
filePath:
{
Description: Specifies a path for the executable file for the application. ,
Required: False ,
}
string ,
commandLineSetting:
{
Description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. ,
Enum:
{
DoNotAllow: No description available. ,
Allow: No description available. ,
Require: No description available. ,
}
,
Required: True ,
}
enum ,
commandLineArguments:
{
Description: Command Line Arguments for Application. ,
Required: False ,
}
string ,
showInPortal:
{
Description: Specifies whether to show the RemoteApp program in the RD Web Access server. ,
Required: False ,
}
boolean ,
iconPath:
{
Description: Path to icon. ,
Required: False ,
}
string ,
iconIndex:
{
Description: Index of the icon. ,
Required: False ,
}
integer ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_Get (removed)
Description :  Get a desktop.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
desktopName:
{
Description: The name of the desktop within the specified desktop group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_Update (removed)
Description :  Update a desktop.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
desktopName:
{
Description: The name of the desktop within the specified desktop group ,
Required: True ,
}
string ,
desktop:
{
Description: Object containing Desktop definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Desktops_List (removed)
Description :  List desktops.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Desktop definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
description:
{
Description: Description of Desktop. ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name of Desktop. ,
Required: False ,
}
string ,
iconHash:
{
Description: Hash of the icon. ,
Required: False ,
}
string ,
iconContent:
{
Description: The icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Get (removed)
Description :  Get a host pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_CreateOrUpdate (removed)
Description :  Create or update a host pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Delete (removed)
Description :  Remove a host pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
force:
{
Description: Force flag to delete sessionHost. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_Update (removed)
Description :  Update a host pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: HostPool properties that can be patched. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_ListByResourceGroup (removed)
Description :  List hostPools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HostPools_List (removed)
Description :  List hostPools in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Personal: No description available. ,
Pooled: No description available. ,
}
,
Required: True ,
}
enum ,
personalDesktopAssignmentType:
{
Description: PersonalDesktopAssignment type for HostPool. ,
Enum:
{
Automatic: No description available. ,
Direct: No description available. ,
}
,
Required: False ,
}
enum ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
ssoContext:
{
Description: Path to keyvault containing ssoContext secret. ,
Required: False ,
}
string ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_ListByHostPool (removed)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Get (removed)
Description :  Get a session host.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Delete (removed)
Description :  Remove a SessionHost.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
force:
{
Description: Force flag to force sessionHost deletion even when userSession exists. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_Update (removed)
Description :  Update a session host.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
sessionHost:
{
Description: Object containing SessionHost definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SessionHosts_List (removed)
Description :  List sessionHosts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SessionHost definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Required: False ,
}
integer ,
agentVersion:
{
Description: Version of agent on SessionHost. ,
Required: False ,
}
string ,
allowNewSession:
{
Description: Allow a new session. ,
Required: False ,
}
boolean ,
virtualMachineId:
{
Description: Virtual Machine Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of SessionHost's underlying virtual machine. ,
Required: False ,
}
string ,
assignedUser:
{
Description: User assigned to SessionHost. ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Shutdown: No description available. ,
Disconnected: No description available. ,
Upgrading: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusTimestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of the OS on the session host. ,
Required: False ,
}
string ,
sxSStackVersion:
{
Description: The version of the side by side stack on the session host. ,
Required: False ,
}
string ,
updateState:
{
Description: Update state of a SessionHost. ,
Enum:
{
Initial: No description available. ,
Pending: No description available. ,
Started: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
updateErrorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Get (removed)
Description :  Get a userSession.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Delete (removed)
Description :  Remove a userSession.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
force:
{
Description: Force flag to login off userSession. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_List (removed)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
userPrincipalName:
{
Description: The user principal name. ,
Required: False ,
}
string ,
applicationType:
{
Description: Application type of application. ,
Enum:
{
RemoteApp: No description available. ,
Desktop: No description available. ,
}
,
Required: False ,
}
enum ,
sessionState:
{
Description: State of user session. ,
Enum:
{
Unknown: No description available. ,
Active: No description available. ,
Disconnected: No description available. ,
Pending: No description available. ,
LogOff: No description available. ,
UserProfileDiskMounted: No description available. ,
}
,
Required: False ,
}
enum ,
activeDirectoryUserName:
{
Description: The active directory user name. ,
Required: False ,
}
string ,
createTime:
{
Description: The timestamp of the user session create. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_Disconnect (removed)
Description :  Disconnect a userSession.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
UserSessions_SendMessage (removed)
Description :  Send a message to a user.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
userSessionId:
{
Description: The name of the user session within the specified session host ,
Required: True ,
}
string ,
sendMessage:
{
Description: Object containing message includes title and message body ,
Required: False ,
}
{
messageTitle:
{
Description: Title of message. ,
Required: False ,
}
string ,
messageBody:
{
Description: Body of message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}