Microsoft.DesktopVirtualization (preview:2024-08-08)

2025/08/15 • 15 updated methods

HostPools_ListRegistrationTokens (updated)
Description :  Operation to list the RegistrationTokens associated with the HostPool.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HostPools_ListRegistrationTokens",
  "Description": {
    "new": "Operation to list the RegistrationTokens associated with the HostPool.",
    "old": "Operation to list the RegistrationTokens associated with the HostPool"
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of RegistrationToken definitions. ,
Required: False ,
}
[
{
expirationTime:
{
Description: Expiration time of registration token. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The registration token base64 encoded string. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByHostPool (updated)
Description :  List private endpoint connections associated with hostpool.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByHostPool",
  "Description": {
    "new": "List private endpoint connections associated with hostpool.",
    "old": "List a PrivateEndpointConnectionWithSystemData"
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnectionWithSystemData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_UpdateByHostPool (updated)
Description :  Approve or reject a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_UpdateByHostPool",
  "Description": {
    "new": "Approve or reject a private endpoint connection.",
    "old": "Create a PrivateEndpointConnectionWithSystemData"
  },
  "$responses": {
    "@removed_324ee82f79314d408478cce68e22bbaf": {
      "201": {
        "Description": "The Private Endpoint Connection resource.",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "The resource-specific properties for this resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "groupIds",
                "Description": "The group ids for the private endpoint resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "privateEndpoint",
                "Description": "The private endpoint resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "id",
                    "Description": "The ARM identifier for private endpoint.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "privateLinkServiceConnectionState",
                "Description": "A collection of information about the state of the connection between service consumer and provider.",
                "Required": true,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "status",
                    "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                    "Enum": [
                      [
                        "Pending",
                        "Connection is Pending"
                      ],
                      [
                        "Approved",
                        "Connection was Approved"
                      ],
                      [
                        "Rejected",
                        "Connection was rejected"
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "description",
                    "Description": "The reason for approval/rejection of the connection.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "actionsRequired",
                    "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "provisioningState",
                "Description": "The provisioning state of the private endpoint connection resource.",
                "Enum": [
                  [
                    "Succeeded",
                    "Provisioning was successful"
                  ],
                  [
                    "Creating",
                    "A PrivateEndpointConnection is being created"
                  ],
                  [
                    "Deleting",
                    "A PrivateEndpointConnection is being deleted"
                  ],
                  [
                    "Failed",
                    "Provisioning failed"
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name parameter for private endpoint ,
Required: True ,
}
string ,
connection:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SessionHostManagementsUpdateStatus_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Properties bag for sessionHostManagement Update Statuses.",
            "old": "Properties bag to hold custom RP properties for sessionHostManagement Update Statuses."
          },
          "$properties": [
            {
              "#name": "correlationId",
              "Description": {
                "new": "The correlation Id for Log Analytics..",
                "old": "The Log Analytics."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SessionHosts_RetryProvisioning (updated)
Description :  Retry provisioning on a SessionHost.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SessionHosts_RetryProvisioning",
  "Description": {
    "new": "Retry provisioning on a SessionHost.",
    "old": "A synchronous resource action that returns no content."
  },
  "$responses": {
    "@added_6793f04a474a4df99ecbc2cb66d30ca1": {
      "#status": "200"
    },
    "@removed_494055b3f9e04be5bb4516f1790e42b5": {
      "#status": "204"
    }
  }
}

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_List (updated)
Description :  List ScalingPlanPersonalSchedules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "daysOfWeek",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampUpStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "peakStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampDownStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "offPeakStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The ScalingPlanPersonalSchedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_Create (updated)
Description :  Create or update a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Create",
  "$parameters": {
    "scalingPlanSchedule": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPersonalSchedule definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_Update (updated)
Description :  Update a ScalingPlanPersonalSchedule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: The resource properties to be updated ,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
Required: False ,
}
enum ,
offPeakMinutesToWaitOnLogoff:
{
Description: The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPersonalSchedule ,
Required: True ,
}
{
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampUpActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp up period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
peakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
rampDownActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the ramp down period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: Start VM on Connect is enabled ,
Disable: Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually ,
}
,
Required: False ,
}
enum ,
offPeakActionOnDisconnect:
{
Description: Action to be taken after a user disconnect during the off-peak period. ,
Enum:
{
None: No action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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 action will be taken after disconnect ,
Deallocate: Session Host will be deallocated after disconnect ,
Hibernate: Session Host will hibernate after disconnect ,
}
,
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: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScalingPlanPooledSchedules_List (updated)
Description :  List ScalingPlanPooledSchedules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "daysOfWeek",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampUpStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampUpCapacityThresholdPct",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "peakStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampDownStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "rampDownCapacityThresholdPct",
                "Required": {
                  "new": false,
                  "old": true
                }
              },
              {
                "#name": "offPeakStartTime",
                "Required": {
                  "new": false,
                  "old": true
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The ScalingPlanPooledSchedule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Create",
  "$parameters": {
    "scalingPlanSchedule": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: Object containing ScalingPlanPooledSchedule definitions. ,
Required: True ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "daysOfWeek",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampUpCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "peakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "rampDownCapacityThresholdPct",
            "Required": {
              "new": false,
              "old": true
            }
          },
          {
            "#name": "offPeakStartTime",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
scalingPlanName:
{
Description: The name of the scaling plan. ,
Required: True ,
}
string ,
scalingPlanScheduleName:
{
Description: The name of the ScalingPlanSchedule ,
Required: True ,
}
string ,
scalingPlanSchedule:
{
Description: The resource properties to be updated ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: False ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: False ,
}
[
string ,
]
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for ScalingPlanPooledSchedule ,
Required: True ,
}
{
name:
{
Description: Name of the ScalingPlanPooledSchedule ,
Required: False ,
}
string ,
daysOfWeek:
{
Description: Set of days of the week on which this schedule is active. ,
Required: 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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
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: Zero Total Sessions ,
ZeroActiveSessions: Zero Active Sessions ,
}
,
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: Breadth First Algorithm for Load Balancing ,
DepthFirst: Depth First Algorithm for Load Balancing ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByWorkspace (updated)
Description :  List private endpoint connections associated with Workspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByWorkspace",
  "Description": {
    "new": "List private endpoint connections associated with Workspace.",
    "old": "List a PrivateEndpointConnectionWithSystemData"
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnectionWithSystemData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_UpdateByWorkspace (updated)
Description :  Approve or reject a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_UpdateByWorkspace",
  "Description": {
    "new": "Approve or reject a private endpoint connection.",
    "old": "Create a PrivateEndpointConnectionWithSystemData"
  },
  "$responses": {
    "@removed_586dd00e627643e68f6fe3c03753585c": {
      "201": {
        "Description": "The Private Endpoint Connection resource.",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "The resource-specific properties for this resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "groupIds",
                "Description": "The group ids for the private endpoint resource.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "privateEndpoint",
                "Description": "The private endpoint resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "id",
                    "Description": "The ARM identifier for private endpoint.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "privateLinkServiceConnectionState",
                "Description": "A collection of information about the state of the connection between service consumer and provider.",
                "Required": true,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "status",
                    "Description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
                    "Enum": [
                      [
                        "Pending",
                        "Connection is Pending"
                      ],
                      [
                        "Approved",
                        "Connection was Approved"
                      ],
                      [
                        "Rejected",
                        "Connection was rejected"
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "description",
                    "Description": "The reason for approval/rejection of the connection.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "actionsRequired",
                    "Description": "A message indicating if changes on the service provider require any updates on the consumer.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "provisioningState",
                "Description": "The provisioning state of the private endpoint connection resource.",
                "Enum": [
                  [
                    "Succeeded",
                    "Provisioning was successful"
                  ],
                  [
                    "Creating",
                    "A PrivateEndpointConnection is being created"
                  ],
                  [
                    "Deleting",
                    "A PrivateEndpointConnection is being deleted"
                  ],
                  [
                    "Failed",
                    "Provisioning failed"
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name parameter for private endpoint ,
Required: True ,
}
string ,
connection:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Connection is Pending ,
Approved: Connection was Approved ,
Rejected: Connection was rejected ,
}
,
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: Provisioning was successful ,
Creating: A PrivateEndpointConnection is being created ,
Deleting: A PrivateEndpointConnection is being deleted ,
Failed: Provisioning failed ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}