Microsoft.DesktopVirtualization (preview:2023-07-07)

2025/03/06 • 72 deleted methods

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

⚼ Request

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

⚐ Response (200)

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

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 (removed)
Description :  Create or update a workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
workspace:
{
Description: Object containing Workspace definitions. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 (removed)
Description :  Remove a workspace.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  Update a workspace.
Reference :  Link ¶

⚼ Request

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

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}
PrivateEndpointConnections_GetByWorkspace (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}
PrivateEndpointConnections_DeleteByWorkspace (removed)
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. ,
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 (removed)
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. ,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}
PrivateLinkResources_ListByWorkspace (removed)
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. ,
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 (removed)
Description :  List workspaces.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 (removed)
Description :  List workspaces in subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Workspace definitions. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
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. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
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. ,
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 (removed)
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. ,
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 of 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 ,
]
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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 (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 (removed)
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. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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 (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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 (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 (removed)
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. ,
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 (removed)
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. ,
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 ,
}
{
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 ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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 (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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
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 ,
}
,
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 ,
}
,
}
,
]
,
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 (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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 (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 (removed)
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. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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 (201)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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 (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 (removed)
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. ,
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 (removed)
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. ,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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 (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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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. ,
}
,
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 ,
}
,
}
,
]
,
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
Description :  Get an application group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Create or update an applicationGroup.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationGroup:
{
Description: Object containing ApplicationGroup definitions. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Remove an applicationGroup.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  Update an applicationGroup.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  List applicationGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are applicationGroupType. ,
Required: False ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  List applicationGroups in subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of ApplicationGroup definitions. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  List start menu items in the given application group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
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 (removed)
Description :  Get an application.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Create or update an application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application within the specified application group ,
Required: True ,
}
string ,
application:
{
Description: Object containing Application definitions. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Remove an application.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  Update an application.
Reference :  Link ¶

⚼ Request

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

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  List applications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Get a desktop.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Update a desktop.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  List desktops.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The name of the application group ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Get a host pool.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 ,
}
,
}
HostPools_CreateOrUpdate (removed)
Description :  Create or update a host pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: True ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 ,
}
,
}
HostPools_Delete (removed)
Description :  Remove a host pool.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  Update a host pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
hostPool:
{
Description: Object containing HostPool definitions. ,
Required: False ,
}
{
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
properties:
{
Description: HostPool properties that can be patched. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of HostPool. ,
Required: False ,
}
string ,
description:
{
Description: Description of HostPool. ,
Required: False ,
}
string ,
customRdpProperty:
{
Description: Custom rdp property of HostPool. ,
Required: False ,
}
string ,
maxSessionLimit:
{
Description: The max session limit of HostPool. ,
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. ,
}
,
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. ,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 ,
}
,
}
HostPools_ListByResourceGroup (removed)
Description :  List hostPools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 ,
}
,
}
HostPools_List (removed)
Description :  List hostPools in subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
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. ,
Required: False ,
}
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
registrationTokenOperation:
{
Description: The type of resetting the token. ,
Enum:
{
Delete: No description available. ,
None: No description available. ,
Update: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
vmTemplate:
{
Description: VM template for sessionhosts configuration within hostpool. ,
Required: False ,
}
string ,
applicationGroupReferences:
{
Description: List of applicationGroup links. ,
Required: False ,
}
[
string ,
]
,
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: No description available. ,
Desktop: No description available. ,
RailApplications: No description available. ,
}
,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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 ,
}
,
}
PrivateLinkResources_ListByHostPool (removed)
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. ,
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 (removed)
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. ,
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 ,
}
,
}
UserSessions_ListByHostPool (removed)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. ,
Required: False ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Get a session host.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
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 ,
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 (removed)
Description :  Remove a SessionHost.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  Update a session host.
Reference :  Link ¶

⚼ Request

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

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
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 ,
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 (removed)
Description :  List sessionHosts.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
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 SessionHost definitions. ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Detailed properties for SessionHost ,
Required: False ,
}
{
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 ,
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 ,
}
,
}
MSIXPackages_Get (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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 (removed)
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. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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 (removed)
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. ,
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 (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 package dependency. ,
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 ,
}
,
}
MsixImages_Expand (removed)
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. ,
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 package dependency. ,
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 ,
}
,
}
UserSessions_Get (removed)
Description :  Get a userSession.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Remove a userSession.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
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 (removed)
Description :  List userSessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostName:
{
Description: The name of the session host within the specified host pool ,
Required: True ,
}
string ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 (removed)
Description :  Disconnect a userSession.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

{
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 (removed)
Description :  Send a message to a user.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

{
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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. ,
}
,
Required: False ,
}
enum ,
exclusionTag:
{
Description: Exclusion tag for scaling plan. ,
Required: False ,
}
string ,
schedules:
{
Description: List of ScalingPlanPooledSchedule 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 ,
]
,
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 (removed)
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. ,
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 ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}
PrivateEndpointConnections_GetByHostPool (removed)
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. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}
PrivateEndpointConnections_DeleteByHostPool (removed)
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. ,
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 (removed)
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. ,
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 ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 ,
}
,
}