Microsoft.DesktopVirtualization (preview:2024-11-01)

2025/03/13 • 94 new 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 ,
}
,
isDataAction:
{
Description: Is a data action. ,
Required: False ,
}
boolean ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification payload ,
Required: False ,
}
{
logSpecifications:
{
Description: Specifications of the Log for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration of the log ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
]
,
publicNetworkAccess:
{
Description: Enabled to allow this resource to be access from the public network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_ListByWorkspace (new)
Description :  List private endpoint connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_GetByWorkspace (new)
Description :  Get a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The Private Endpoint Connection resource. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_DeleteByWorkspace (new)
Description :  Remove a connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_UpdateByWorkspace (new)
Description :  Approve or reject a private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
connection:
{
Description: Object containing the updated connection. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: The Private Endpoint Connection resource. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_ListByWorkspace (new)
Description :  List the private link resources available for this workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Workspace ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Workspace. (internal use) ,
Required: False ,
}
string ,
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 ,
]
,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_Get (new)
Description :  Get a scaling plan.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_Create (new)
Description :  Create or update a scaling plan.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlan:
{
Description: Object containing scaling plan definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_Delete (new)
Description :  Remove a scaling plan.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_Update (new)
Description :  Update a scaling plan.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlan:
{
Description: Object containing scaling plan definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for scaling plan ,
Required: False ,
}
{
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: False ,
}
string ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_ListByResourceGroup (new)
Description :  List scaling plans.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of scaling plan definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPooledSchedules_Get (new)
Description :  Get a ScalingPlanPooledSchedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPooledSchedules_Create (new)
Description :  Create or update a ScalingPlanPooledSchedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPooledSchedule definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPooledSchedules_Delete (new)
Description :  Remove a ScalingPlanPooledSchedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPooledSchedules_Update (new)
Description :  Update a ScalingPlanPooledSchedule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPooledSchedule definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: False ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPooledSchedules_List (new)
Description :  List ScalingPlanPooledSchedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of ScalingPlanPooledSchedule definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: True ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: True ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPersonalSchedules_Get (new)
Description :  Get a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPersonalSchedules_Create (new)
Description :  Create or update a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPersonalSchedule definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPersonalSchedules_Delete (new)
Description :  Remove a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPersonalSchedules_Update (new)
Description :  Update a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPersonalSchedule definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: False ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlanPersonalSchedules_List (new)
Description :  List ScalingPlanPersonalSchedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of ScalingPlanPersonalSchedule definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: True ,
}
[
string ,
]
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpAutoStartHosts:
{
Description: The desired startup behavior during the ramp up period for personal vms in the hostpool. ,
Enum:
{
None: Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts. ,
WithAssignedUser: Session hosts with an assigned user will be started during Ramp Up ,
All: All personal session hosts in the hostpool will be started during ramp up. ,
}
,
Required: False ,
}
enum ,
rampUpStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp up period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakActionOnLogoff:
{
Description: Action to be taken after a logoff during the peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
peakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownActionOnLogoff:
{
Description: Action to be taken after a logoff during the ramp down period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: True ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakStartVMOnConnect:
{
Description: The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnDisconnect:
{
Description: The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
offPeakActionOnLogoff:
{
Description: Action to be taken after a logoff during the off-peak period. ,
Enum:
{
None: No description available. ,
Deallocate: No description available. ,
Hibernate: No description available. ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_ListBySubscription (new)
Description :  List scaling plans in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of scaling plan definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ApplicationGroup ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of ApplicationGroup. (internal use) ,
Required: False ,
}
string ,
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 ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
showInFeed:
{
Description: Boolean representing whether the applicationGroup is show in the feed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ 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 ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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 ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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 ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of Application definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Application ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of Application. (internal use) ,
Required: False ,
}
string ,
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 ,
msixPackageFamilyName:
{
Description: Specifies the package family name for MSIX applications ,
Required: False ,
}
string ,
msixPackageApplicationId:
{
Description: Specifies the package application Id for MSIX applications ,
Required: False ,
}
string ,
applicationType:
{
Description: Resource Type of Application. ,
Enum:
{
InBuilt: No description available. ,
MsixApplication: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Format: int32 ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Desktop. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of Desktop. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of Desktop definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for Desktop ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of Desktop. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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. ,
Format: int32 ,
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. ,
MultiplePersistent: No description available. ,
}
,
Required: False ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: False ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled to allow this resource to be access from the public network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of HostPool definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for HostPool ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of HostPool. (internal use) ,
Required: False ,
}
string ,
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: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
BYODesktop: Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct. ,
}
,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
loadBalancerType:
{
Description: The type of the load balancer. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
Persistent: No description available. ,
MultiplePersistent: No description available. ,
}
,
Required: True ,
}
enum ,
ring:
{
Description: The ring number of HostPool. ,
Format: int32 ,
Required: False ,
}
integer ,
validationEnvironment:
{
Description: Is validation environment. ,
Required: False ,
}
boolean ,
registrationInfo:
{
Description: The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls. ,
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 ,
managementType:
{
Description: The type of management for this hostpool, Automated or Standard. The default value is Automated. ,
Enum:
{
Automated: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
appAttachPackageReferences:
{
Description: List of App Attach Package links. ,
Required: False ,
}
[
string ,
]
,
ssoadfsAuthority:
{
Description: URL to customer ADFS server for signing WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientId:
{
Description: ClientId for the registered Relying Party used to issue WVD SSO certificates. ,
Required: False ,
}
string ,
ssoClientSecretKeyVaultPath:
{
Description: Path to Azure KeyVault storing the secret used for communication to ADFS. ,
Required: False ,
}
string ,
ssoSecretType:
{
Description: The type of single sign on Secret Type. ,
Enum:
{
SharedKey: No description available. ,
Certificate: No description available. ,
SharedKeyInKeyVault: No description available. ,
CertificateInKeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
preferredAppGroupType:
{
Description: The type of preferred application group type, default to Desktop Application Group ,
Enum:
{
None: This value is read only, it is not accepted on input. ,
Desktop: Users access the full Windows desktop from a session host. Available with pooled or personal host pools. ,
RailApplications: Users access individual applications you select and publish to the application group. Available with pooled host pools only. ,
}
,
Required: True ,
}
enum ,
startVMOnConnect:
{
Description: The flag to turn on/off StartVMOnConnect feature. ,
Required: False ,
}
boolean ,
cloudPcResource:
{
Description: Is cloud pc resource. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
EnabledForSessionHostsOnly: No description available. ,
EnabledForClientsOnly: No description available. ,
}
,
Required: False ,
}
enum ,
agentUpdate:
{
Description: The session host configuration for updating agent, monitoring agent, and stack component. ,
Required: False ,
}
{
type:
{
Description: The type of maintenance for session host components. ,
Enum:
{
Default: Agent and other agent side components are delivery schedule is controlled by WVD Infra. ,
Scheduled: TenantAdmin have opted in for Scheduled Component Update feature. ,
}
,
Required: False ,
}
enum ,
useSessionHostLocalTime:
{
Description: Whether to use localTime of the virtual machine. ,
Required: False ,
}
boolean ,
maintenanceWindowTimeZone:
{
Description: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
maintenanceWindows:
{
Description: List of maintenance windows. Maintenance windows are 2 hours long. ,
Required: False ,
}
[
{
hour:
{
Description: The update start hour of the day. (0 - 23) ,
Format: int32 ,
Required: False ,
}
integer ,
dayOfWeek:
{
Description: Day of the week. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified resource ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
managedPrivateUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
directUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
publicUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
relayUDP:
{
Description: Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections ,
Enum:
{
Default: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHostManagements_Get (new)
Description :  Get a SessionHostManagement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHostManagements_CreateOrUpdate (new)
Description :  Create or update a SessionHostManagement.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
sessionHostManagement:
{
Description: Object containing SessionHostManagement definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHostManagements_Update (new)
Description :  Update a SessionHostManagement.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
sessionHostManagement:
{
Description: Object containing SessionHostManagement definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHostManagementPatch ,
Required: False ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: False ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHostManagements_ListByHostPool (new)
Description :  List SessionHostManagements by hostPool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SessionHostManagement definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
InitiateSessionHostUpdate_Post (new)
Description :  Initiates a hostpool update or schedule an update for the future.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
updateSessionHostsRequestBody:
{
Description: Object containing the definition for properties to be used in the sessionHostUpdate validation. ,
Required: False ,
}
{
scheduledDateTime:
{
Description: The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately ,
Format: date-time ,
Required: False ,
}
string ,
scheduledDateTimeZone:
{
Description: The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. ,
Required: False ,
}
string ,
update:
{
Description: settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object. ,
Required: False ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ControlSessionHostUpdate_Post (new)
Description :  Control update of a hostpool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
hostPoolUpdateControlParameter:
{
Description: Object containing control action for hostpool update. ,
Required: True ,
}
{
action:
{
Description: Action types for controlling hostpool update. ,
Enum:
{
Start: Start the hostpool update. ,
Pause: Pause the hostpool update. ,
Cancel: Cancel the hostpool update. ,
Retry: Retry the hostpool update. ,
Resume: Resume the hostpool update. ,
}
,
Required: True ,
}
enum ,
cancelMessage:
{
Description: The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SessionHostManagementsUpdateStatus_Get (new)
Description :  Get the session host update status for a given hostpool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. Current defined values are < Error | Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling > | Succeeded | Failed | Canceled ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: If present, details of the operation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
properties:
{
Description: The custom properties of the SessionHost Update Status. ,
Required: False ,
}
{
correlationId:
{
Description: The Log Analytics. ,
Required: False ,
}
string ,
progress:
{
Description: Progress information on the sessionHostManagement operation. ,
Required: False ,
}
{
executionStartTime:
{
Description: Time that the sessionHostManagement operation was created. ,
Format: date-time ,
Required: False ,
}
string ,
totalSessionHosts:
{
Description: The number of sessionHosts to be started in the sessionHostManagement operation. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionHostsInProgress:
{
Description: The number of sessionHosts in progress in the sessionHostManagement operation. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionHostsCompleted:
{
Description: The number of sessionHosts completed in the sessionHostManagement operation. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionHostsRollbackFailed:
{
Description: The number of sessionHosts rollback failed in the sessionHostManagement operation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduledDateTime:
{
Description: The timestamp that the update is scheduled for. ,
Format: date-time ,
Required: False ,
}
string ,
sessionHostManagement:
{
Description: SessionHostManagement properties used for the operation. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SessionHostConfigurations_CreateOrUpdate (new)
Description :  Create or update a SessionHostConfiguration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
sessionHostConfiguration:
{
Description: Object containing SessionHostConfiguration definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
Description: Represents a SessionHostConfiguration definition. ,
}
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
Description: Represents a SessionHostConfiguration definition. ,
}
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SessionHostConfigurations_Update (new)
Description :  Update a SessionHostConfiguration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
sessionHostConfiguration:
{
Description: Object containing SessionHostConfiguration definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHostConfigurationPatch ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: False ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: False ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: False ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: False ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: False ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: False ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: False ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: False ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: False ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: False ,
}
{
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: False ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: False ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: False ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: False ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: False ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
Description: Represents a SessionHostConfiguration definition. ,
}
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SessionHostConfigurations_Get (new)
Description :  Get a SessionHostConfiguration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHostConfigurations_ListByHostPool (new)
Description :  List sessionHostConfigurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SessionHostConfiguration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Session Host Configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ActiveSessionHostConfigurations_Get (new)
Description :  Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ActiveSessionHostConfigurations_ListByHostPool (new)
Description :  List activeSessionHostConfigurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ActiveSessionHostConfiguration definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHostConfiguration ,
Required: True ,
}
{
version:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly name to describe this version of the SessionHostConfiguration. ,
Required: False ,
}
string ,
vmTags:
{
Description: Hashtable that lists key/value pair tags to apply to the VMs ,
Required: False ,
}
object ,
vmLocation:
{
Description: The Location for the session host to be created in. It will default to the location of the hostpool if not provided. ,
Required: False ,
}
string ,
vmResourceGroup:
{
Description: The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided. ,
Required: False ,
}
string ,
vmNamePrefix:
{
Description: The prefix that should be associated with session host names ,
Required: True ,
}
string ,
availabilityZones:
{
Description: Value for availability zones to be used by the session host. Should be from [1,2,3]. ,
Required: False ,
}
[
integer ,
]
,
networkInfo:
{
Description: Network information. ,
Required: True ,
}
{
subnetId:
{
Description: The resource ID of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
securityGroupId:
{
Description: The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG). ,
Required: False ,
}
string ,
}
,
vmSizeId:
{
Description: The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6 ,
Required: True ,
}
string ,
diskInfo:
{
Description: Disk information. ,
Required: True ,
}
{
type:
{
Description: The disk type used by virtual machine in hostpool session host. ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
}
,
Required: True ,
}
enum ,
}
,
customConfigurationScriptUrl:
{
Description: The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning. ,
Format: uri ,
Required: False ,
}
string ,
imageInfo:
{
Description: Image configurations of HostPool. ,
Required: True ,
}
{
type:
{
Description: The type of image session hosts use in the hostpool. ,
Enum:
{
Marketplace: Using default marketplace images offered by Azure Marketplace. ,
Custom: Using a custom image. ,
}
,
Required: True ,
}
enum ,
marketplaceInfo:
{
Description: The values to uniquely identify a marketplace image. Only one should be populated based on the image type. ,
Required: False ,
}
{
offer:
{
Description: The offer of the image. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the image. ,
Required: True ,
}
string ,
sku:
{
Description: The sku of the image. ,
Required: True ,
}
string ,
exactVersion:
{
Description: The exact version of the image. ,
Required: True ,
}
string ,
}
,
customInfo:
{
Description: The values to uniquely identify a custom image. Only one should be populated based on the image type. ,
Required: False ,
}
{
resourceId:
{
Description: The resource id of the custom image. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
domainInfo:
{
Description: Domain configurations of session hosts. ,
Required: True ,
}
{
joinType:
{
Description: The type of domain join done by the virtual machine. ,
Enum:
{
ActiveDirectory: Using microsoft active directory. ,
AzureActiveDirectory: Using microsoft azure active directory. ,
}
,
Required: True ,
}
enum ,
activeDirectoryInfo:
{
Description: Active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
domainCredentials:
{
Description: Credentials needed to create the virtual machine. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
ouPath:
{
Description: The organizational unit(OU) path. ,
Required: True ,
}
string ,
domainName:
{
Description: The domain a virtual machine connected to a hostpool will join. ,
Required: False ,
}
string ,
}
,
azureActiveDirectoryInfo:
{
Description: Azure active directory info. Only one should be populated based on the join type. ,
Required: False ,
}
{
mdmProviderGuid:
{
Description: The Mobile Device Management(MDM) guid. ,
Required: True ,
}
string ,
}
,
}
,
securityInfo:
{
Description: Security information. ,
Required: False ,
}
{
type:
{
Description: The security type used by virtual machine in hostpool session host. Default is Standard. ,
Enum:
{
Standard: Standard security protocol. No additional parameters ,
TrustedLaunch: TrustedLaunch allows for secure boot adn vTPM ,
ConfidentialVM: Confidential Virtual Machine security protocol ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Whether to use secureBoot on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Whether to use vTPM on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
vmAdminCredentials:
{
Description: Local Admin credentials for session hosts. ,
Required: True ,
}
{
usernameKeyVaultSecretUri:
{
Description: The uri to access the secret that the username is stored in. ,
Format: uri ,
Required: True ,
}
string ,
passwordKeyVaultSecretUri:
{
Description: The uri to access the secret that the password is stored in. ,
Format: uri ,
Required: True ,
}
string ,
}
,
bootDiagnosticsInfo:
{
Description: Boot Diagnostics information. ,
Required: False ,
}
{
enabled:
{
Description: Whether boot diagnostics should be enabled on the Virtual Machine. ,
Required: False ,
}
boolean ,
storageUri:
{
Description: Uri of the storage account to use for placing the console output and screenshot.

If storageUri is not specified while enabling boot diagnostics, managed storage will be used. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_ListByHostPool (new)
Description :  List the private link resources available for this hostpool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
HostPools_RetrieveRegistrationToken (new)
Description :  Registration token of the host pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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)

{
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 ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
HostPools_ListRegistrationTokens (new)
Description :  Operation to list the RegistrationTokens associated with the HostPool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 RegistrationToken definitions. ,
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 ,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of user session. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
activeSessions:
{
Description: Number of active sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
disconnectedSessions:
{
Description: Number of disconnected sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingSessions:
{
Description: Number of pending sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
objectId:
{
Description: ObjectId of SessionHost. (internal use) ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Format: int32 ,
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 ,
friendlyName:
{
Description: Friendly name of SessionHost ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: Session Host has passed all the health checks and is available to handle connections. ,
Unavailable: Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status. ,
Shutdown: Session Host is shutdown - RD Agent reported session host to be stopped or deallocated. ,
Disconnected: The Session Host is unavailable because it is currently disconnected. ,
Upgrading: Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections. ,
UpgradeFailed: Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed. ,
NoHeartbeat: The Session Host is not heart beating. ,
NotJoinedToDomain: SessionHost is not joined to domain. ,
DomainTrustRelationshipLost: SessionHost's domain trust relationship lost ,
SxSStackListenerNotReady: SxS stack installed on the SessionHost is not ready to receive connections. ,
FSLogixNotHealthy: FSLogix is in an unhealthy state on the session host. ,
NeedsAssistance: New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal. ,
}
,
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 ,
lastSessionHostUpdateTime:
{
Description: The last time update was completed. ,
Format: date-time ,
Required: False ,
}
string ,
sessionHostConfiguration:
{
Description: SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z ,
Required: False ,
}
string ,
sessionHostHealthCheckResults:
{
Description: List of SessionHostHealthCheckReports ,
Required: False ,
}
[
{
healthCheckName:
{
Description: Represents the name of the health check operation performed. ,
Enum:
{
DomainJoinedCheck: Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled) ,
DomainTrustCheck: Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled) ,
FSLogixHealthCheck: Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled) ,
SxSStackListenerCheck: Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled) ,
UrlsAccessibleCheck: Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled) ,
MonitoringAgentCheck: Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled) ,
DomainReachable: Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled) ,
WebRTCRedirectorCheck: Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled) ,
SupportedEncryptionCheck: Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled) ,
MetaDataServiceCheck: Verifies the metadata service is accessible and return compute properties. (Currently Enabled) ,
AppAttachHealthCheck: Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled) ,
}
,
Required: False ,
}
enum ,
healthCheckResult:
{
Description: Represents the Health state of the health check we performed. ,
Enum:
{
Unknown: Health check result is not currently known. ,
HealthCheckSucceeded: Health check passed. ,
HealthCheckFailed: Health check failed. ,
SessionHostShutdown: We received a Shutdown notification. ,
}
,
Required: False ,
}
enum ,
additionalFailureDetails:
{
Description: Additional detailed information on the failure. ,
Required: False ,
}
{
message:
{
Description: Failure message: hints on what is wrong and how to recover. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code corresponding for the failure. ,
Format: int32 ,
Required: False ,
}
integer ,
lastHealthCheckDateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
friendlyName:
{
Description: Friendly name of SessionHost ,
Required: False ,
}
string ,
}
,
}
,
force:
{
Description: Force flag to update assign, unassign or reassign personal desktop. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
activeSessions:
{
Description: Number of active sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
disconnectedSessions:
{
Description: Number of disconnected sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingSessions:
{
Description: Number of pending sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
objectId:
{
Description: ObjectId of SessionHost. (internal use) ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Format: int32 ,
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 ,
friendlyName:
{
Description: Friendly name of SessionHost ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: Session Host has passed all the health checks and is available to handle connections. ,
Unavailable: Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status. ,
Shutdown: Session Host is shutdown - RD Agent reported session host to be stopped or deallocated. ,
Disconnected: The Session Host is unavailable because it is currently disconnected. ,
Upgrading: Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections. ,
UpgradeFailed: Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed. ,
NoHeartbeat: The Session Host is not heart beating. ,
NotJoinedToDomain: SessionHost is not joined to domain. ,
DomainTrustRelationshipLost: SessionHost's domain trust relationship lost ,
SxSStackListenerNotReady: SxS stack installed on the SessionHost is not ready to receive connections. ,
FSLogixNotHealthy: FSLogix is in an unhealthy state on the session host. ,
NeedsAssistance: New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal. ,
}
,
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 ,
lastSessionHostUpdateTime:
{
Description: The last time update was completed. ,
Format: date-time ,
Required: False ,
}
string ,
sessionHostConfiguration:
{
Description: SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z ,
Required: False ,
}
string ,
sessionHostHealthCheckResults:
{
Description: List of SessionHostHealthCheckReports ,
Required: False ,
}
[
{
healthCheckName:
{
Description: Represents the name of the health check operation performed. ,
Enum:
{
DomainJoinedCheck: Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled) ,
DomainTrustCheck: Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled) ,
FSLogixHealthCheck: Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled) ,
SxSStackListenerCheck: Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled) ,
UrlsAccessibleCheck: Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled) ,
MonitoringAgentCheck: Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled) ,
DomainReachable: Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled) ,
WebRTCRedirectorCheck: Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled) ,
SupportedEncryptionCheck: Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled) ,
MetaDataServiceCheck: Verifies the metadata service is accessible and return compute properties. (Currently Enabled) ,
AppAttachHealthCheck: Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled) ,
}
,
Required: False ,
}
enum ,
healthCheckResult:
{
Description: Represents the Health state of the health check we performed. ,
Enum:
{
Unknown: Health check result is not currently known. ,
HealthCheckSucceeded: Health check passed. ,
HealthCheckFailed: Health check failed. ,
SessionHostShutdown: We received a Shutdown notification. ,
}
,
Required: False ,
}
enum ,
additionalFailureDetails:
{
Description: Additional detailed information on the failure. ,
Required: False ,
}
{
message:
{
Description: Failure message: hints on what is wrong and how to recover. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code corresponding for the failure. ,
Format: int32 ,
Required: False ,
}
integer ,
lastHealthCheckDateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
vmPath:
{
Description: The path to the VM. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SessionHost definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
activeSessions:
{
Description: Number of active sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
disconnectedSessions:
{
Description: Number of disconnected sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingSessions:
{
Description: Number of pending sessions on SessionHost. ,
Format: int32 ,
Required: False ,
}
integer ,
objectId:
{
Description: ObjectId of SessionHost. (internal use) ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Last heart beat from SessionHost. ,
Format: date-time ,
Required: False ,
}
string ,
sessions:
{
Description: Number of sessions on SessionHost. ,
Format: int32 ,
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 ,
friendlyName:
{
Description: Friendly name of SessionHost ,
Required: False ,
}
string ,
status:
{
Description: Status for a SessionHost. ,
Enum:
{
Available: Session Host has passed all the health checks and is available to handle connections. ,
Unavailable: Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status. ,
Shutdown: Session Host is shutdown - RD Agent reported session host to be stopped or deallocated. ,
Disconnected: The Session Host is unavailable because it is currently disconnected. ,
Upgrading: Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections. ,
UpgradeFailed: Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed. ,
NoHeartbeat: The Session Host is not heart beating. ,
NotJoinedToDomain: SessionHost is not joined to domain. ,
DomainTrustRelationshipLost: SessionHost's domain trust relationship lost ,
SxSStackListenerNotReady: SxS stack installed on the SessionHost is not ready to receive connections. ,
FSLogixNotHealthy: FSLogix is in an unhealthy state on the session host. ,
NeedsAssistance: New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal. ,
}
,
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 ,
lastSessionHostUpdateTime:
{
Description: The last time update was completed. ,
Format: date-time ,
Required: False ,
}
string ,
sessionHostConfiguration:
{
Description: SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z ,
Required: False ,
}
string ,
sessionHostHealthCheckResults:
{
Description: List of SessionHostHealthCheckReports ,
Required: False ,
}
[
{
healthCheckName:
{
Description: Represents the name of the health check operation performed. ,
Enum:
{
DomainJoinedCheck: Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled) ,
DomainTrustCheck: Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled) ,
FSLogixHealthCheck: Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled) ,
SxSStackListenerCheck: Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled) ,
UrlsAccessibleCheck: Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled) ,
MonitoringAgentCheck: Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled) ,
DomainReachable: Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled) ,
WebRTCRedirectorCheck: Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled) ,
SupportedEncryptionCheck: Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled) ,
MetaDataServiceCheck: Verifies the metadata service is accessible and return compute properties. (Currently Enabled) ,
AppAttachHealthCheck: Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled) ,
}
,
Required: False ,
}
enum ,
healthCheckResult:
{
Description: Represents the Health state of the health check we performed. ,
Enum:
{
Unknown: Health check result is not currently known. ,
HealthCheckSucceeded: Health check passed. ,
HealthCheckFailed: Health check failed. ,
SessionHostShutdown: We received a Shutdown notification. ,
}
,
Required: False ,
}
enum ,
additionalFailureDetails:
{
Description: Additional detailed information on the failure. ,
Required: False ,
}
{
message:
{
Description: Failure message: hints on what is wrong and how to recover. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code corresponding for the failure. ,
Format: int32 ,
Required: False ,
}
integer ,
lastHealthCheckDateTime:
{
Description: The timestamp of the last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SessionHost_RetryProvisioning (new)
Description :  Retry provisioning on a SessionHost.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MSIXPackages_Get (new)
Description :  Get a msixpackage.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MSIXPackages_CreateOrUpdate (new)
Description :  Create or update a MSIX package.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
msixPackage:
{
Description: Object containing MSIX Package definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MSIXPackages_Delete (new)
Description :  Remove an MSIX Package.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MSIXPackages_Update (new)
Description :  Update an MSIX Package.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
msixPackageFullName:
{
Description: The version specific package full name of the MSIX package within specified hostpool ,
Required: True ,
}
string ,
msixPackage:
{
Description: Object containing MSIX Package definitions. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: False ,
}
{
isActive:
{
Description: Set a version of the package to be active across hostpool. ,
Required: False ,
}
boolean ,
isRegularRegistration:
{
Description: Set Registration mode. Regular or Delayed. ,
Required: False ,
}
boolean ,
displayName:
{
Description: Display name for MSIX Package. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
MSIXPackages_List (new)
Description :  List MSIX packages in hostpool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of MSIX Package definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for MSIX Package ,
Required: True ,
}
{
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AppAttachPackageInfo_Import (new)
Description :  Gets information from a package given the path to the package.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
importPackageInfoRequest:
{
Description: Object containing URI to package image and other optional properties ,
Required: True ,
}
{
path:
{
Description: URI to Image ,
Required: False ,
}
string ,
packageArchitecture:
{
Description: Possible device architectures that an app attach package can be configured for ,
Enum:
{
ARM: No description available. ,
ARM64: No description available. ,
x86: No description available. ,
x64: No description available. ,
Neutral: No description available. ,
x86a64: No description available. ,
ALL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of App Attach Package definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MsixImages_Expand (new)
Description :  Expands and Lists MSIX packages in an Image, given the Image Path.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
msixImageURI:
{
Description: Object containing URI to MSIX Image ,
Required: True ,
}
{
uri:
{
Description: URI to Image ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of MSIX package properties from give MSIX Image. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for ExpandMsixImage ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of MSIX Package. ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Package Full Name from appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date Package was last updated, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AppAttachPackage_Get (new)
Description :  Get an app attach package.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appAttachPackageName:
{
Description: The name of the App Attach package arm object ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AppAttachPackage_CreateOrUpdate (new)
Description :  Create or update an App Attach package.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appAttachPackageName:
{
Description: The name of the App Attach package arm object ,
Required: True ,
}
string ,
appAttachPackage:
{
Description: Object containing App Attach Package definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AppAttachPackage_Delete (new)
Description :  Remove an App Attach Package.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appAttachPackageName:
{
Description: The name of the App Attach package arm object ,
Required: True ,
}
string ,
force:
{
Description: Force flag to delete App Attach package. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AppAttachPackage_Update (new)
Description :  Update an App Attach Package
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appAttachPackageName:
{
Description: The name of the App Attach package arm object ,
Required: True ,
}
string ,
appAttachPackagePatch:
{
Description: Object containing App Attach Package definition. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, should be null for first party packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AppAttachPackage_ListByResourceGroup (new)
Description :  List App Attach packages in resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 package name, host pool, package owner name, and custom data. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of App Attach Package definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AppAttachPackage_ListBySubscription (new)
Description :  List App Attach packages in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are package name, resource group, host pool, package owner name, and custom data. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of App Attach Package definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for App Attach Package ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the App Attach Package. ,
Enum:
{
Succeeded: No description available. ,
Provisioning: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Detailed properties for App Attach Package ,
Required: False ,
}
{
packageAlias:
{
Description: Alias of App Attach Package. Assigned at import time ,
Required: False ,
}
string ,
imagePath:
{
Description: VHD/CIM/APP-V image path on Network Share. ,
Required: False ,
}
string ,
packageName:
{
Description: Package Name from appxmanifest.xml. ,
Required: False ,
}
string ,
packageFamilyName:
{
Description: Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. ,
Required: False ,
}
string ,
packageFullName:
{
Description: Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. ,
Required: False ,
}
string ,
displayName:
{
Description: User friendly Name to be displayed in the portal. ,
Required: False ,
}
string ,
packageRelativePath:
{
Description: Relative Path to the package inside the image. ,
Required: False ,
}
string ,
isRegularRegistration:
{
Description: Specifies how to register Package in feed. ,
Required: False ,
}
boolean ,
isActive:
{
Description: Make this version of the package the active one across the hostpool. ,
Required: False ,
}
boolean ,
packageDependencies:
{
Description: List of package dependencies. ,
Required: False ,
}
[
{
dependencyName:
{
Description: Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files ,
Required: False ,
}
string ,
publisher:
{
Description: Name of dependency publisher. ,
Required: False ,
}
string ,
minVersion:
{
Description: Dependency version required. ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: Package Version found in the appxmanifest.xml. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
packageApplications:
{
Description: List of package applications. ,
Required: False ,
}
[
{
appId:
{
Description: Package Application Id, found in appxmanifest.xml. ,
Required: False ,
}
string ,
description:
{
Description: Description of Package Application. ,
Required: False ,
}
string ,
appUserModelID:
{
Description: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
iconImageName:
{
Description: User friendly name. ,
Required: False ,
}
string ,
rawIcon:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
rawPng:
{
Description: the icon a 64 bit string as a byte array. ,
Format: byte ,
Required: False ,
}
string ,
}
,
]
,
certificateName:
{
Description: Certificate name found in the appxmanifest.xml. ,
Required: False ,
}
string ,
certificateExpiry:
{
Description: Date certificate expires, found in the appxmanifest.xml. ,
Format: date-time ,
Required: False ,
}
string ,
isPackageTimestamped:
{
Description: Is package timestamped so it can ignore the certificate expiry date ,
Enum:
{
Timestamped: No description available. ,
NotTimestamped: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hostPoolReferences:
{
Description: List of Hostpool resource Ids. ,
Required: False ,
}
[
string ,
]
,
keyVaultURL:
{
Description: URL of keyvault location to store certificate ,
Required: False ,
}
string ,
failHealthCheckOnStagingFailure:
{
Description: Parameter indicating how the health check should behave if this package fails staging ,
Enum:
{
Unhealthy: No description available. ,
NeedsAssistance: No description available. ,
DoNotFail: No description available. ,
}
,
Required: False ,
}
enum ,
packageOwnerName:
{
Description: Specific name of package owner, is "AppAttach" for native app attach packages ,
Required: False ,
}
string ,
packageLookbackUrl:
{
Description: Lookback url to third party control plane, is null for native app attach packages ,
Format: uri ,
Required: False ,
}
string ,
customData:
{
Description: Field that can be populated with custom data and filtered on in list GET calls ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
{
objectId:
{
Description: ObjectId of user session. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of UserSession definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for UserSession ,
Required: False ,
}
{
objectId:
{
Description: ObjectId of user session. (internal use) ,
Required: False ,
}
string ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
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. The value must be an UUID. ,
Format: uuid ,
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)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
ScalingPlans_ListByHostPool (new)
Description :  List scaling plan associated with hostpool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of scaling plan definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Detailed properties for scaling plan. ,
Required: True ,
}
{
objectId:
{
Description: ObjectId of scaling plan. (internal use) ,
Required: False ,
}
string ,
description:
{
Description: Description of scaling plan. ,
Required: False ,
}
string ,
friendlyName:
{
Description: User friendly name of scaling plan. ,
Required: False ,
}
string ,
timeZone:
{
Description: Timezone of the scaling plan. ,
Required: True ,
}
string ,
hostPoolType:
{
Description: HostPool type for desktop. ,
Enum:
{
Pooled: Users get a new (random) SessionHost every time it connects to the HostPool. ,
Personal: Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of Pooled ScalingSchedule definitions. ,
Required: False ,
}
[
{
name:
{
Description: Name of the ScalingPlanPooledSchedule. ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
scalingMethod:
{
Description: The desired scaling method to be used to scale the hosts in the assigned host pool. ,
Enum:
{
PowerManage: Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size. ,
CreateDeletePowerManage: Scaling will manage the hosts in the host pool by power managing the hosts, as well as creating and deleting hosts to modify the host pool size. This requires the create delete object to be set, and the assigned hostpool to have a session host config property. ,
}
,
Required: False ,
}
enum ,
createDelete:
{
Description: The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts. ,
Required: False ,
}
{
rampUpMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMaximumHostPoolSize:
{
Description: Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownMinimumHostPoolSize:
{
Description: Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
rampUpStartTime:
{
Description: Starting time for ramp up period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampUpLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp up period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampUpMinimumHostsPct:
{
Description: Minimum host percentage for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpCapacityThresholdPct:
{
Description: Capacity threshold for ramp up period. ,
Format: int32 ,
Required: False ,
}
integer ,
peakStartTime:
{
Description: Starting time for peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
peakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownStartTime:
{
Description: Starting time for ramp down period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
rampDownLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for ramp down period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownMinimumHostsPct:
{
Description: Minimum host percentage for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownCapacityThresholdPct:
{
Description: Capacity threshold for ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownForceLogoffUsers:
{
Description: Should users be logged off forcefully from hosts. ,
Required: False ,
}
boolean ,
rampDownStopHostsWhen:
{
Description: Specifies when to stop hosts during ramp down period. ,
Enum:
{
ZeroSessions: No description available. ,
ZeroActiveSessions: No description available. ,
}
,
Required: False ,
}
enum ,
rampDownWaitTimeMinutes:
{
Description: Number of minutes to wait to stop hosts during ramp down period. ,
Format: int32 ,
Required: False ,
}
integer ,
rampDownNotificationMessage:
{
Description: Notification message for users during ramp down period. ,
Required: False ,
}
string ,
offPeakStartTime:
{
Description: Starting time for off-peak period. ,
Required: False ,
}
{
hour:
{
Description: The hour. ,
Format: int32 ,
Required: True ,
}
integer ,
minute:
{
Description: The minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
offPeakLoadBalancingAlgorithm:
{
Description: Load balancing algorithm for off-peak period. ,
Enum:
{
BreadthFirst: No description available. ,
DepthFirst: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostPoolReferences:
{
Description: List of ScalingHostPoolReference definitions. ,
Required: False ,
}
[
{
hostPoolArmPath:
{
Description: Arm path of referenced hostpool. ,
Required: False ,
}
string ,
scalingPlanEnabled:
{
Description: Is the scaling plan enabled for this hostpool. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_ListByHostPool (new)
Description :  List private endpoint connections associated with hostpool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
pageSize:
{
Description: Number of items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
isDescending:
{
Description: Indicates whether the collection is descending. ,
Required: False ,
}
boolean ,
initialSkip:
{
Description: Initial number of items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_GetByHostPool (new)
Description :  Get a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The Private Endpoint Connection resource. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_DeleteByHostPool (new)
Description :  Remove a connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error object properties. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_UpdateByHostPool (new)
Description :  Approve or reject a private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
connection:
{
Description: Object containing the updated connection. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: The Private Endpoint Connection resource. ,
}
object ,
}

⚐ Response (default)

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